3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Abdelrazak Younes
9 * Full author contact details are available in file CREDITS.
14 #include "TocWidget.h"
16 #include "GuiApplication.h"
18 #include "qt_helpers.h"
22 #include "BufferView.h"
23 #include "CutAndPaste.h"
24 #include "FuncRequest.h"
25 #include "FuncStatus.h"
28 #include "TocBackend.h"
30 #include "insets/InsetCommand.h"
31 #include "insets/InsetRef.h"
33 #include "support/debug.h"
34 #include "support/lassert.h"
36 #include <QHeaderView>
42 #define DELAY_UPDATE_VIEW
49 TocWidget::TocWidget(GuiView & gui_view, QWidget * parent)
50 : QWidget(parent), depth_(0), persistent_(false), gui_view_(gui_view), update_delay_(0)
55 moveOutTB->setIcon(QIcon(getPixmap("images/", "promote", "png")));
56 moveInTB->setIcon(QIcon(getPixmap("images/", "demote", "png")));
57 moveUpTB->setIcon(QIcon(getPixmap("images/", "up", "png")));
58 moveDownTB->setIcon(QIcon(getPixmap("images/", "down", "png")));
59 updateTB->setIcon(QIcon(getPixmap("images/", "reload", "png")));
62 tocTV->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
66 // hide the pointless QHeader for now
67 // in the future, new columns may appear
68 // like labels, bookmarks, etc...
69 // tocTV->header()->hide();
70 tocTV->header()->setVisible(false);
72 // Only one item selected at a time.
73 tocTV->setSelectionMode(QAbstractItemView::SingleSelection);
76 // The toc types combo won't change its model.
77 typeCO->setModel(gui_view_.tocModels().nameModel());
79 // Make sure the buttons are disabled when first shown without a loaded
81 enableControls(false);
83 // make us responsible for the context menu of the tabbar
84 setContextMenuPolicy(Qt::CustomContextMenu);
85 connect(this, SIGNAL(customContextMenuRequested(const QPoint &)),
86 this, SLOT(showContextMenu(const QPoint &)));
87 connect(tocTV, SIGNAL(customContextMenuRequested(const QPoint &)),
88 this, SLOT(showContextMenu(const QPoint &)));
89 connect(filterLE, SIGNAL(textEdited(QString)),
90 this, SLOT(filterContents()));
96 void TocWidget::showContextMenu(const QPoint & pos)
98 std::string name = "context-toc-" + fromqstr(current_type_);
99 QMenu * menu = guiApp->menus().menu(toqstr(name), gui_view_);
102 menu->exec(mapToGlobal(pos));
106 Inset * TocWidget::itemInset() const
108 QModelIndex const & index = tocTV->currentIndex();
109 TocItem const & item =
110 gui_view_.tocModels().currentItem(current_type_, index);
111 DocIterator const & dit = item.dit();
114 if (current_type_ == "label"
115 || current_type_ == "graphics"
116 || current_type_ == "citation"
117 || current_type_ == "child")
118 inset = dit.nextInset();
120 else if (current_type_ == "branch"
121 || current_type_ == "index"
122 || current_type_ == "change")
123 inset = &dit.inset();
125 else if (current_type_ == "table"
126 || current_type_ == "listing"
127 || current_type_ == "figure") {
128 DocIterator tmp_dit(dit);
130 inset = &tmp_dit.inset();
136 bool TocWidget::getStatus(Cursor & cur, FuncRequest const & cmd,
137 FuncStatus & status) const
139 Inset * inset = itemInset();
140 FuncRequest tmpcmd(cmd);
142 QModelIndex const & index = tocTV->currentIndex();
143 TocItem const & item =
144 gui_view_.tocModels().currentItem(current_type_, index);
146 switch (cmd.action())
148 case LFUN_CHANGE_ACCEPT:
149 case LFUN_CHANGE_REJECT:
150 case LFUN_OUTLINE_UP:
151 case LFUN_OUTLINE_DOWN:
152 case LFUN_OUTLINE_IN:
153 case LFUN_OUTLINE_OUT:
154 case LFUN_SECTION_SELECT:
155 status.setEnabled(item.dit() != 0);
158 case LFUN_LABEL_COPY_AS_REF: {
159 // For labels in math, we need to supply the label as a string
160 FuncRequest label_copy(LFUN_LABEL_COPY_AS_REF, item.asString());
162 return inset->getStatus(cur, label_copy, status);
167 return inset->getStatus(cur, tmpcmd, status);
174 void TocWidget::doDispatch(Cursor & cur, FuncRequest const & cmd)
176 Inset * inset = itemInset();
177 FuncRequest tmpcmd(cmd);
179 QModelIndex const & index = tocTV->currentIndex();
180 TocItem const & item =
181 gui_view_.tocModels().currentItem(current_type_, index);
183 // Start an undo group.
184 cur.beginUndoGroup();
186 switch (cmd.action())
188 case LFUN_CHANGE_ACCEPT:
189 case LFUN_CHANGE_REJECT:
190 case LFUN_SECTION_SELECT:
191 dispatch(item.action());
192 cur.dispatch(tmpcmd);
195 case LFUN_LABEL_COPY_AS_REF: {
196 // For labels in math, we need to supply the label as a string
197 FuncRequest label_copy(LFUN_LABEL_COPY_AS_REF, item.asString());
199 inset->dispatch(cur, label_copy);
203 case LFUN_OUTLINE_UP:
204 case LFUN_OUTLINE_DOWN:
205 case LFUN_OUTLINE_IN:
206 case LFUN_OUTLINE_OUT:
207 outline(cmd.action());
212 inset->dispatch(cur, tmpcmd);
218 void TocWidget::on_tocTV_activated(QModelIndex const & index)
224 void TocWidget::on_tocTV_pressed(QModelIndex const & index)
226 Qt::MouseButtons const button = QApplication::mouseButtons();
227 if (button & Qt::LeftButton) {
229 gui_view_.setFocus();
234 void TocWidget::goTo(QModelIndex const & index)
236 LYXERR(Debug::GUI, "goto " << index.row()
237 << ", " << index.column());
239 gui_view_.tocModels().goTo(current_type_, index);
243 void TocWidget::on_updateTB_clicked()
245 // The backend update can take some time so we disable
246 // the controls while waiting.
247 enableControls(false);
248 gui_view_.currentBufferView()->buffer().updateBuffer();
252 void TocWidget::on_sortCB_stateChanged(int state)
254 gui_view_.tocModels().sort(current_type_, state == Qt::Checked);
259 void TocWidget::on_persistentCB_stateChanged(int state)
261 persistent_ = state == Qt::Checked;
266 /* FIXME (Ugras 17/11/06):
267 I have implemented a indexDepth function to get the model indices. In my
268 opinion, somebody should derive a new qvariant class for tocModelItem
269 which saves the string data and depth information. That will save the
270 depth calculation. */
272 static int indexDepth(QModelIndex const & index, int depth = -1)
275 return index.parent() == QModelIndex()
276 ? depth : indexDepth(index.parent(), depth);
280 void TocWidget::on_depthSL_valueChanged(int depth)
285 gui_view_.setFocus();
289 void TocWidget::setTreeDepth(int depth)
296 tocTV->collapseAll();
298 tocTV->expandToDepth(depth - 1);
302 void TocWidget::on_typeCO_currentIndexChanged(int index)
306 current_type_ = typeCO->itemData(index).toString();
308 if (typeCO->hasFocus())
309 gui_view_.setFocus();
313 void TocWidget::outline(FuncCode func_code)
315 QModelIndexList const & list = tocTV->selectionModel()->selectedIndexes();
318 enableControls(false);
320 dispatch(FuncRequest(func_code));
321 enableControls(true);
322 gui_view_.setFocus();
326 void TocWidget::on_moveUpTB_clicked()
328 outline(LFUN_OUTLINE_UP);
332 void TocWidget::on_moveDownTB_clicked()
334 outline(LFUN_OUTLINE_DOWN);
338 void TocWidget::on_moveInTB_clicked()
340 outline(LFUN_OUTLINE_IN);
344 void TocWidget::on_moveOutTB_clicked()
346 outline(LFUN_OUTLINE_OUT);
350 void TocWidget::select(QModelIndex const & index)
352 if (!index.isValid()) {
353 LYXERR(Debug::GUI, "TocWidget::select(): QModelIndex is invalid!");
357 tocTV->scrollTo(index);
358 tocTV->clearSelection();
359 tocTV->setCurrentIndex(index);
363 void TocWidget::enableControls(bool enable)
365 updateTB->setEnabled(enable);
370 moveUpTB->setEnabled(enable);
371 moveDownTB->setEnabled(enable);
372 moveInTB->setEnabled(enable);
373 moveOutTB->setEnabled(enable);
377 void TocWidget::updateView()
379 // Enable if you dont want the delaying business, cf #7138.
380 #ifndef DELAY_UPDATE_VIEW
384 // already scheduled?
385 if (update_delay_ == -1)
387 QTimer::singleShot(update_delay_, this, SLOT(updateViewForce()));
388 // Subtler optimization for having the delay more UI invisible.
389 // We trigger update immediately for sparse editation actions,
390 // i.e. there was no editation/cursor movement in last 2 sec.
391 // At worst there will be +1 redraw after 2s in a such "calm" mode.
392 if (update_delay_ != 0)
397 void TocWidget::updateViewForce()
399 update_delay_ = 2000;
400 if (!gui_view_.documentBufferView()) {
402 depthSL->setMaximum(0);
403 depthSL->setValue(0);
408 bool const is_sortable = isSortable();
409 sortCB->setEnabled(is_sortable);
410 bool focus_ = tocTV->hasFocus();
411 tocTV->setEnabled(false);
412 tocTV->setUpdatesEnabled(false);
414 QAbstractItemModel * toc_model =
415 gui_view_.tocModels().model(current_type_);
416 if (tocTV->model() != toc_model) {
417 tocTV->setModel(toc_model);
418 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
420 setTreeDepth(depth_);
423 sortCB->blockSignals(true);
424 sortCB->setChecked(is_sortable
425 && gui_view_.tocModels().isSorted(current_type_));
426 sortCB->blockSignals(false);
428 bool const can_navigate_ = canNavigate();
429 persistentCB->setEnabled(can_navigate_);
431 bool controls_enabled = toc_model && toc_model->rowCount() > 0
432 && !gui_view_.documentBufferView()->buffer().isReadonly();
433 enableControls(controls_enabled);
435 depthSL->setMaximum(gui_view_.tocModels().depth(current_type_));
436 depthSL->setValue(depth_);
437 if (!persistent_ && can_navigate_)
438 setTreeDepth(depth_);
440 persistentCB->setChecked(persistent_);
441 select(gui_view_.tocModels().currentIndex(current_type_));
444 tocTV->setEnabled(true);
445 tocTV->setUpdatesEnabled(true);
451 void TocWidget::filterContents()
456 QModelIndexList indices = tocTV->model()->match(
457 tocTV->model()->index(0, 0),
458 Qt::DisplayRole, "*", -1,
459 Qt::MatchFlags(Qt::MatchWildcard|Qt::MatchRecursive));
461 int size = indices.size();
462 for (int i = 0; i < size; i++) {
463 QModelIndex index = indices[i];
465 index.data().toString().contains(
466 filterLE->text(), Qt::CaseInsensitive);
467 tocTV->setRowHidden(index.row(), index.parent(), !matches);
469 // recursively unhide parents of unhidden children
470 for (int i = size - 1; i >= 0; i--) {
471 QModelIndex index = indices[i];
472 if (!tocTV->isRowHidden(index.row(), index.parent())
473 && index.parent() != QModelIndex())
474 tocTV->setRowHidden(index.parent().row(),
475 index.parent().parent(), false);
480 static QString decodeType(QString const & str)
483 if (type.contains("tableofcontents"))
484 type = "tableofcontents";
485 else if (type.contains("lstlistoflistings"))
487 else if (type.contains("floatlist")) {
488 if (type.contains("\"figure"))
490 else if (type.contains("\"table"))
492 else if (type.contains("\"algorithm"))
499 void TocWidget::init(QString const & str)
503 new_index = typeCO->findData(current_type_);
505 new_index = typeCO->findData(decodeType(str));
507 // If everything else fails, settle on the table of contents which is
508 // guaranteed to exist.
509 if (new_index == -1) {
510 current_type_ = "tableofcontents";
511 new_index = typeCO->findData(current_type_);
513 current_type_ = typeCO->itemData(new_index).toString();
516 typeCO->blockSignals(true);
517 typeCO->setCurrentIndex(new_index);
518 typeCO->blockSignals(false);
520 // no delay when the whole outliner is reseted.
524 } // namespace frontend
527 #include "moc_TocWidget.cpp"