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"
20 #include "FancyLineEdit.h"
23 #include "BufferView.h"
25 #include "CutAndPaste.h"
26 #include "FuncRequest.h"
27 #include "FuncStatus.h"
30 #include "TocBackend.h"
32 #include "insets/InsetCommand.h"
33 #include "insets/InsetRef.h"
35 #include "support/debug.h"
36 #include "support/lassert.h"
38 #include <QHeaderView>
49 TocWidget::TocWidget(GuiView & gui_view, QWidget * parent)
50 : QWidget(parent), depth_(0), persistent_(false), keep_expanded_(false),
51 gui_view_(gui_view), timer_(new QTimer(this))
55 moveOutTB->setIcon(QIcon(getPixmap("images/", "outline-out", "svgz,png")));
56 moveInTB->setIcon(QIcon(getPixmap("images/", "outline-in", "svgz,png")));
57 moveUpTB->setIcon(QIcon(getPixmap("images/", "outline-up", "svgz,png")));
58 moveDownTB->setIcon(QIcon(getPixmap("images/", "outline-down", "svgz,png")));
59 updateTB->setIcon(QIcon(getPixmap("images/", "reload", "svgz,png")));
61 QSize icon_size = gui_view.iconSize();
62 moveOutTB->setIconSize(icon_size);
63 moveInTB->setIconSize(icon_size);
64 moveUpTB->setIconSize(icon_size);
65 moveDownTB->setIconSize(icon_size);
66 updateTB->setIconSize(icon_size);
69 tocTV->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
73 // hide the pointless QHeader for now
74 // in the future, new columns may appear
75 // like labels, bookmarks, etc...
76 // tocTV->header()->hide();
77 tocTV->header()->setVisible(false);
79 // Only one item selected at a time.
80 tocTV->setSelectionMode(QAbstractItemView::SingleSelection);
82 // The toc types combo won't change its model.
83 typeCO->setModel(gui_view_.tocModels().nameModel());
86 filter_ = new FancyLineEdit(this);
87 filter_->setClearButton(true);
88 filter_->setPlaceholderText(qt_("All items"));
89 filterBarL->addWidget(filter_, 0);
90 filterLA->setBuddy(filter_);
91 setFocusProxy(filter_);
93 // Make sure the buttons are disabled when first shown without a loaded
95 enableControls(false);
97 // make us responsible for the context menu of the tabbar
98 setContextMenuPolicy(Qt::CustomContextMenu);
99 connect(this, SIGNAL(customContextMenuRequested(const QPoint &)),
100 this, SLOT(showContextMenu(const QPoint &)));
101 connect(tocTV, SIGNAL(customContextMenuRequested(const QPoint &)),
102 this, SLOT(showContextMenu(const QPoint &)));
103 connect(filter_, SIGNAL(textEdited(QString)),
104 this, SLOT(filterContents()));
105 connect(filter_, &FancyLineEdit::downPressed,
106 tocTV, [this](){ focusAndHighlight(tocTV); });
107 connect(activeFilterCO, SIGNAL(activated(int)),
108 this, SLOT(filterContents()));
110 // setting the update timer
111 timer_->setSingleShot(true);
112 connect(timer_, SIGNAL(timeout()), this, SLOT(finishUpdateView()));
118 void TocWidget::showContextMenu(const QPoint & pos)
120 std::string name = "context-toc-" + fromqstr(current_type_);
121 QMenu * menu = guiApp->menus().menu(toqstr(name), gui_view_);
124 menu->exec(mapToGlobal(pos));
128 Inset * TocWidget::itemInset() const
130 QModelIndex const & index = tocTV->currentIndex();
131 TocItem const & item =
132 gui_view_.tocModels().currentItem(current_type_, index);
133 DocIterator const & dit = item.dit();
135 Inset * inset = nullptr;
136 if (current_type_ == "label"
137 || current_type_ == "graphics"
138 || current_type_ == "citation"
139 || current_type_ == "child")
140 inset = dit.nextInset();
142 else if (current_type_ == "branch"
143 || current_type_ == "index"
144 || current_type_ == "change"
145 || current_type_ == "table"
146 || current_type_ == "listing"
147 || current_type_ == "figure")
148 inset = &dit.inset();
154 bool TocWidget::getStatus(Cursor & cur, FuncRequest const & cmd,
155 FuncStatus & status) const
157 Inset * inset = itemInset();
158 FuncRequest tmpcmd(cmd);
160 QModelIndex const & index = tocTV->currentIndex();
161 TocItem const & item =
162 gui_view_.tocModels().currentItem(current_type_, index);
164 switch (cmd.action())
166 case LFUN_CHANGE_ACCEPT:
167 case LFUN_CHANGE_REJECT:
168 case LFUN_OUTLINE_UP:
169 case LFUN_OUTLINE_DOWN:
170 case LFUN_OUTLINE_IN:
171 case LFUN_OUTLINE_OUT:
172 case LFUN_SECTION_SELECT:
173 status.setEnabled((bool)item.dit());
176 case LFUN_LABEL_COPY_AS_REFERENCE: {
177 // For labels in math, we need to supply the label as a string
178 FuncRequest label_copy(LFUN_LABEL_COPY_AS_REFERENCE, item.str());
180 return inset->getStatus(cur, label_copy, status);
186 return inset->getStatus(cur, tmpcmd, status);
193 void TocWidget::doDispatch(Cursor & cur, FuncRequest const & cmd,
196 Inset * inset = itemInset();
198 QModelIndex const & index = tocTV->currentIndex();
199 TocItem const & item =
200 gui_view_.tocModels().currentItem(current_type_, index);
202 // Start an undo group.
203 cur.beginUndoGroup();
205 switch (cmd.action())
207 case LFUN_CHANGE_ACCEPT:
208 case LFUN_CHANGE_REJECT: {
209 // The action is almost always LYX_UNKNOWN_ACTION, which will
210 // have the effect of moving the cursor to the location of
211 // the change. (See TocItem::action.)
212 dispatch(item.action());
213 // If we do not reset the origin, then the request will be sent back
214 // here, and we are in an infinite loop. But we need the dispatch
215 // machinery to clean up for us, if the cursor is in an inset that
216 // will be deleted. See bug #10316.
217 FuncRequest tmpcmd(cmd);
218 tmpcmd.setOrigin(FuncRequest::INTERNAL);
220 dr.forceBufferUpdate();
224 case LFUN_SECTION_SELECT:
225 dispatch(item.action());
227 // necessary to get the selection drawn.
228 cur.buffer()->changed(true);
229 gui_view_.setFocus();
232 case LFUN_LABEL_COPY_AS_REFERENCE: {
233 // For labels in math, we need to supply the label as a string
234 FuncRequest label_copy(LFUN_LABEL_COPY_AS_REFERENCE, item.str());
236 inset->dispatch(cur, label_copy);
240 case LFUN_OUTLINE_UP:
241 case LFUN_OUTLINE_DOWN:
242 case LFUN_OUTLINE_IN:
243 case LFUN_OUTLINE_OUT:
244 outline(cmd.action());
248 FuncRequest tmpcmd(cmd);
250 inset->dispatch(cur, tmpcmd);
257 void TocWidget::on_tocTV_activated(QModelIndex const & index)
263 void TocWidget::on_tocTV_pressed(QModelIndex const & index)
265 DocIterator const & dit = gui_view_.documentBufferView()->cursor();
266 keep_expanded_ = gui_view_.tocModels().currentIndex(current_type_, dit) == index;
267 Qt::MouseButtons const button = QApplication::mouseButtons();
268 if (button & Qt::LeftButton) {
270 gui_view_.setFocus();
271 gui_view_.activateWindow();
276 void TocWidget::on_tocTV_doubleClicked(QModelIndex const &)
278 keep_expanded_ = true;
282 void TocWidget::goTo(QModelIndex const & index)
284 LYXERR(Debug::GUI, "goto " << index.row()
285 << ", " << index.column());
287 sendDispatch(gui_view_.tocModels().goTo(current_type_, index));
291 void TocWidget::on_updateTB_clicked()
293 // The backend update can take some time so we disable
294 // the controls while waiting.
295 enableControls(false);
296 gui_view_.currentBufferView()->buffer().updateBuffer();
300 void TocWidget::on_sortCB_stateChanged(int state)
302 gui_view_.tocModels().sort(current_type_, state == Qt::Checked);
307 void TocWidget::on_persistentCB_stateChanged(int state)
309 persistent_ = state == Qt::Checked;
314 /* FIXME (Ugras 17/11/06):
315 I have implemented a indexDepth function to get the model indices. In my
316 opinion, somebody should derive a new qvariant class for tocModelItem
317 which saves the string data and depth information. That will save the
318 depth calculation. */
320 static int indexDepth(QModelIndex const & index, int depth = -1)
323 return index.parent() == QModelIndex()
324 ? depth : indexDepth(index.parent(), depth);
328 void TocWidget::on_depthSL_valueChanged(int depth)
333 gui_view_.setFocus();
337 void TocWidget::setTreeDepth(int depth)
344 tocTV->collapseAll();
346 tocTV->expandToDepth(depth - 1);
350 void TocWidget::on_typeCO_activated(int index)
354 current_type_ = typeCO->itemData(index).toString();
356 if (typeCO->hasFocus())
357 gui_view_.setFocus();
361 void TocWidget::outline(FuncCode func_code)
363 QModelIndexList const & list = tocTV->selectionModel()->selectedIndexes();
367 //if another window is active, this attempt will fail,
368 //but it will work at least for the second attempt
369 gui_view_.activateWindow();
371 enableControls(false);
373 sendDispatch(FuncRequest(func_code));
374 enableControls(true);
375 gui_view_.setFocus();
379 void TocWidget::sendDispatch(FuncRequest fr)
381 fr.setViewOrigin(&gui_view_);
382 GuiWorkArea * old_wa = gui_view_.currentWorkArea();
383 GuiWorkArea * doc_wa = gui_view_.currentMainWorkArea();
384 /* The ToC command should be dispatched to the document work area,
385 * not the Adv. Find&Replace (which is the only other know
388 if (doc_wa != nullptr && doc_wa != old_wa)
389 gui_view_.setCurrentWorkArea(doc_wa);
390 DispatchResult const & dr = dispatch(fr);
391 /* If the current workarea has not explicitely changed, and the
392 * original one is still visible, let's reset it.
394 if (gui_view_.currentWorkArea() == doc_wa
395 && gui_view_.hasVisibleWorkArea(old_wa)
397 gui_view_.setCurrentWorkArea(old_wa);
399 gui_view_.message(dr.message());
403 void TocWidget::on_moveUpTB_clicked()
405 outline(LFUN_OUTLINE_UP);
409 void TocWidget::on_moveDownTB_clicked()
411 outline(LFUN_OUTLINE_DOWN);
415 void TocWidget::on_moveInTB_clicked()
417 outline(LFUN_OUTLINE_IN);
421 void TocWidget::on_moveOutTB_clicked()
423 outline(LFUN_OUTLINE_OUT);
427 void TocWidget::select(QModelIndex const & index)
429 if (!index.isValid()) {
430 LYXERR(Debug::GUI, "TocWidget::select(): QModelIndex is invalid!");
434 tocTV->scrollTo(index);
435 tocTV->clearSelection();
436 tocTV->setCurrentIndex(index);
440 void TocWidget::enableControls(bool enable)
442 updateTB->setEnabled(enable);
447 moveUpTB->setEnabled(enable);
448 moveDownTB->setEnabled(enable);
449 moveInTB->setEnabled(enable);
450 moveOutTB->setEnabled(enable);
454 void TocWidget::updateView()
456 if (!gui_view_.documentBufferView()) {
457 tocTV->setModel(nullptr);
458 depthSL->setMaximum(0);
459 depthSL->setValue(0);
464 bool const is_sortable = isSortable();
465 sortCB->setEnabled(is_sortable);
466 bool focus = tocTV->hasFocus();
467 tocTV->setEnabled(false);
468 tocTV->setUpdatesEnabled(false);
470 QAbstractItemModel * toc_model =
471 gui_view_.tocModels().model(current_type_);
472 if (tocTV->model() != toc_model) {
473 tocTV->setModel(toc_model);
474 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
476 setTreeDepth(depth_);
479 sortCB->blockSignals(true);
480 sortCB->setChecked(is_sortable
481 && gui_view_.tocModels().isSorted(current_type_));
482 sortCB->blockSignals(false);
484 persistentCB->setEnabled(canNavigate());
486 bool controls_enabled = toc_model && toc_model->rowCount() > 0
487 && !gui_view_.documentBufferView()->buffer().isReadonly();
488 enableControls(controls_enabled);
490 depthSL->setMaximum(gui_view_.tocModels().depth(current_type_));
491 depthSL->setValue(depth_);
492 tocTV->setEnabled(true);
493 tocTV->setUpdatesEnabled(true);
497 // Expensive operations are on a timer. We finish the update immediately
498 // for sparse edition actions, i.e. there was no edition/cursor movement
499 // recently, then every 300ms.
500 if (!timer_->isActive() && !keep_expanded_) {
504 keep_expanded_ = false;
508 void TocWidget::updateViewNow()
515 void TocWidget::finishUpdateView()
517 // Profiling shows that this is the expensive stuff in the context of typing
518 // text and moving with arrows. For bigger operations, this is negligible,
519 // and outweighted by TocModels::reset() anyway.
521 if (!persistent_ && !keep_expanded_)
522 setTreeDepth(depth_);
523 keep_expanded_ = false;
524 persistentCB->setChecked(persistent_);
525 // select the item at current cursor location
526 if (gui_view_.documentBufferView()) {
527 DocIterator const & dit = gui_view_.documentBufferView()->cursor();
528 select(gui_view_.tocModels().currentIndex(current_type_, dit));
535 void TocWidget::filterContents()
540 QModelIndexList indices = tocTV->model()->match(
541 tocTV->model()->index(0, 0),
542 Qt::DisplayRole, ".*", -1,
543 #if QT_VERSION >= QT_VERSION_CHECK(5, 15, 0)
544 Qt::MatchFlags(Qt::MatchRegularExpression|Qt::MatchRecursive));
546 // deprecated in Qt 5.15.
547 Qt::MatchFlags(Qt::MatchRegExp|Qt::MatchRecursive));
550 bool const show_active =
551 activeFilterCO->currentIndex() != 2;
552 bool const show_inactive =
553 activeFilterCO->currentIndex() != 1;
555 int size = indices.size();
556 QString const matchstring = filter_ ? filter_->text() : QString();
557 for (int i = 0; i < size; i++) {
558 QModelIndex index = indices[i];
559 bool matches = index.data().toString().contains(
560 matchstring, Qt::CaseInsensitive);
561 TocItem const & item =
562 gui_view_.tocModels().currentItem(current_type_, index);
563 matches &= (show_active && item.isOutput()) || (show_inactive && !item.isOutput());
564 tocTV->setRowHidden(index.row(), index.parent(), !matches);
566 // recursively unhide parents of unhidden children
567 for (int i = size - 1; i >= 0; i--) {
568 QModelIndex index = indices[i];
569 if (!tocTV->isRowHidden(index.row(), index.parent())
570 && index.parent() != QModelIndex())
571 tocTV->setRowHidden(index.parent().row(),
572 index.parent().parent(), false);
577 static QString decodeType(QString const & str)
580 if (type.contains("tableofcontents"))
581 type = "tableofcontents";
582 else if (type.contains("lstlistoflistings"))
584 else if (type.contains("floatlist")) {
585 if (type.contains("\"figure"))
587 else if (type.contains("\"table"))
589 else if (type.contains("\"algorithm"))
596 void TocWidget::init(QString const & str)
600 new_index = typeCO->findData(current_type_);
602 new_index = typeCO->findData(decodeType(str));
604 // If everything else fails, settle on the table of contents which is
605 // guaranteed to exist.
606 if (new_index == -1) {
607 current_type_ = "tableofcontents";
608 new_index = typeCO->findData(current_type_);
610 current_type_ = typeCO->itemData(new_index).toString();
613 typeCO->blockSignals(true);
614 typeCO->setCurrentIndex(new_index);
615 typeCO->blockSignals(false);
618 setTreeDepth(depth_);
621 } // namespace frontend
624 #include "moc_TocWidget.cpp"