src/frontends/qt4/TocWidget.cpp

   1 /**
   2  * \file TocWidget.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  * \author Abdelrazak Younes
   8  *
   9  * Full author contact details are available in file CREDITS.
  10  */
  11
  12 #include <config.h>
  13
  14 #include "TocWidget.h"
  15
  16 #include "GuiView.h"
  17 #include "qt_helpers.h"
  18 #include "TocModel.h"
  19
  20 #include "FuncRequest.h"
  21 #include "LyXFunc.h"
  22
  23 #include "support/debug.h"
  24
  25 #include <QHeaderView>
  26 #include <QTimer>
  27
  28 #include <vector>
  29
  30 using namespace std;
  31
  32 namespace lyx {
  33 namespace frontend {
  34
  35 TocWidget::TocWidget(GuiView & gui_view, QWidget * parent)
  36         : QWidget(parent), depth_(0), gui_view_(gui_view)
  37 {
  38         setupUi(this);
  39
  40         moveOutTB->setIcon(QIcon(":/images/promote.png"));
  41         moveInTB->setIcon(QIcon(":/images/demote.png"));
  42         moveUpTB->setIcon(QIcon(":/images/up.png"));
  43         moveDownTB->setIcon(QIcon(":/images/down.png"));
  44         updateTB->setIcon(QIcon(":/images/reload.png"));
  45
  46         // avoid flickering
  47         tocTV->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
  48
  49         tocTV->showColumn(0);
  50
  51         // hide the pointless QHeader for now
  52         // in the future, new columns may appear
  53         // like labels, bookmarks, etc...
  54         // tocTV->header()->hide();
  55         tocTV->header()->setVisible(false);
  56
  57         // Only one item selected at a time.
  58         tocTV->setSelectionMode(QAbstractItemView::SingleSelection);
  59 }
  60
  61
  62 void TocWidget::on_tocTV_activated(QModelIndex const & index)
  63 {
  64         goTo(index);
  65 }
  66
  67
  68 void TocWidget::on_tocTV_clicked(QModelIndex const & index)
  69 {
  70         goTo(index);
  71         gui_view_.setFocus();
  72 }
  73
  74
  75 void TocWidget::goTo(QModelIndex const & index)
  76 {
  77         LYXERR(Debug::GUI, "goto " << index.row()
  78                 << ", " << index.column());
  79
  80         gui_view_.tocModels().goTo(typeCO->currentIndex(), index);
  81 }
  82
  83
  84 void TocWidget::on_updateTB_clicked()
  85 {
  86         // The backend update can take some time so we disable
  87         // the controls while waiting.
  88         enableControls(false);
  89         gui_view_.tocModels().updateBackend();
  90 }
  91
  92 /* FIXME (Ugras 17/11/06):
  93 I have implemented a getIndexDepth function to get the model indices. In my
  94 opinion, somebody should derive a new qvariant class for tocModelItem
  95 which saves the string data and depth information. that will save the
  96 depth calculation.
  97 */
  98 int TocWidget::getIndexDepth(QModelIndex const & index, int depth)
  99 {
 100         ++depth;
 101         return (index.parent() == QModelIndex())
 102                 ? depth : getIndexDepth(index.parent(),depth);
 103 }
 104
 105
 106 void TocWidget::on_depthSL_valueChanged(int depth)
 107 {
 108         if (depth == depth_)
 109                 return;
 110         setTreeDepth(depth);
 111 }
 112
 113
 114 void TocWidget::setTreeDepth(int depth)
 115 {
 116         depth_ = depth;
 117
 118         // expanding and then collapsing is probably better,
 119         // but my qt 4.1.2 doesn't have expandAll()..
 120         //tocTV->expandAll();
 121         QModelIndexList indices = tocTV->model()->match(
 122                 tocTV->model()->index(0,0),
 123                 Qt::DisplayRole, "*", -1,
 124                 Qt::MatchFlags(Qt::MatchWildcard|Qt::MatchRecursive));
 125
 126         int size = indices.size();
 127         for (int i = 0; i < size; i++) {
 128                 QModelIndex index = indices[i];
 129                 tocTV->setExpanded(index, getIndexDepth(index) < depth_);
 130         }
 131 }
 132
 133
 134 void TocWidget::on_typeCO_currentIndexChanged(int value)
 135 {
 136         setTocModel(value);
 137 }
 138
 139
 140 void TocWidget::outline(int func_code)
 141 {
 142         enableControls(false);
 143         QModelIndexList const & list = tocTV->selectionModel()->selectedIndexes();
 144         if (list.isEmpty())
 145                 return;
 146         enableControls(false);
 147         goTo(list[0]);
 148         dispatch(FuncRequest(static_cast<FuncCode>(func_code)));
 149         enableControls(true);
 150 }
 151
 152
 153 void TocWidget::on_moveUpTB_clicked()
 154 {
 155         outline(LFUN_OUTLINE_UP);
 156 }
 157
 158
 159 void TocWidget::on_moveDownTB_clicked()
 160 {
 161         outline(LFUN_OUTLINE_DOWN);
 162 }
 163
 164
 165 void TocWidget::on_moveInTB_clicked()
 166 {
 167         outline(LFUN_OUTLINE_IN);
 168 }
 169
 170
 171 void TocWidget::on_moveOutTB_clicked()
 172 {
 173         outline(LFUN_OUTLINE_OUT);
 174 }
 175
 176
 177 void TocWidget::select(QModelIndex const & index)
 178 {
 179         if (!index.isValid()) {
 180                 LYXERR(Debug::GUI, "TocWidget::select(): QModelIndex is invalid!");
 181                 return;
 182         }
 183
 184         tocTV->scrollTo(index);
 185         tocTV->clearSelection();
 186         tocTV->setCurrentIndex(index);
 187 }
 188
 189
 190 void TocWidget::enableControls(bool enable)
 191 {
 192         updateTB->setEnabled(enable);
 193
 194         if (!gui_view_.tocModels().canOutline(typeCO->currentIndex()))
 195                 enable = false;
 196
 197         moveUpTB->setEnabled(enable);
 198         moveDownTB->setEnabled(enable);
 199         moveInTB->setEnabled(enable);
 200         moveOutTB->setEnabled(enable);
 201
 202         depthSL->setEnabled(enable);
 203 }
 204
 205
 206 void TocWidget::updateView()
 207 {
 208         LYXERR(Debug::GUI, "In TocWidget::updateView()");
 209         setTreeDepth(depth_);
 210         select(gui_view_.tocModels().currentIndex(typeCO->currentIndex()));
 211 }
 212
 213
 214 void TocWidget::init(QString const & str)
 215 {
 216         QStringList const & type_names = gui_view_.tocModels().typeNames();
 217         if (type_names.isEmpty()) {
 218                 enableControls(false);
 219                 typeCO->clear();
 220                 tocTV->setModel(new QStandardItemModel);
 221                 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
 222                 return;
 223         }
 224
 225         int selected_type = gui_view_.tocModels().decodeType(str);
 226
 227         QString const current_text = typeCO->currentText();
 228         typeCO->blockSignals(true);
 229         typeCO->clear();
 230         for (int i = 0; i != type_names.size(); ++i)
 231                 typeCO->addItem(type_names[i]);
 232         if (!str.isEmpty())
 233                 typeCO->setCurrentIndex(selected_type);
 234         else {
 235                 int const new_index = typeCO->findText(current_text);
 236                 if (new_index != -1)
 237                         typeCO->setCurrentIndex(new_index);
 238                 else
 239                         typeCO->setCurrentIndex(selected_type);
 240         }
 241
 242         typeCO->blockSignals(false);
 243
 244         setTocModel(typeCO->currentIndex());
 245 }
 246
 247
 248 void TocWidget::setTocModel(size_t type)
 249 {
 250         bool controls_enabled = false;
 251         QStandardItemModel * toc_model = gui_view_.tocModels().model(type);
 252         if (toc_model) {
 253                 controls_enabled = toc_model->rowCount() > 0;
 254                 tocTV->setModel(toc_model);
 255                 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
 256                 LYXERR(Debug::GUI, "tocModel()->rowCount "
 257                         << toc_model->rowCount()
 258                         << "\nform_->tocModel()->columnCount "
 259                         << toc_model->columnCount());
 260         }
 261
 262         enableControls(controls_enabled);
 263
 264         if (controls_enabled) {
 265                 depthSL->setMaximum(gui_view_.tocModels().depth(type));
 266                 depthSL->setValue(depth_);
 267         }
 268
 269         // setTocModel produce QTreeView reset and setting depth again
 270         // is needed. That must be done after all Qt updates are processed.
 271         QTimer::singleShot(0, this, SLOT(updateView()));
 272 }
 273
 274 } // namespace frontend
 275 } // namespace lyx
 276
 277 #include "TocWidget_moc.cpp"