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_REFERENCE: {
159 // For labels in math, we need to supply the label as a string
160 FuncRequest label_copy(LFUN_LABEL_COPY_AS_REFERENCE, 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 dispatch(item.action());
191 cur.dispatch(tmpcmd);
194 case LFUN_SECTION_SELECT:
195 dispatch(item.action());
196 cur.dispatch(tmpcmd);
197 // necessary to get the selection drawn.
198 cur.buffer()->changed(true);
201 case LFUN_LABEL_COPY_AS_REFERENCE: {
202 // For labels in math, we need to supply the label as a string
203 FuncRequest label_copy(LFUN_LABEL_COPY_AS_REFERENCE, item.asString());
205 inset->dispatch(cur, label_copy);
209 case LFUN_OUTLINE_UP:
210 case LFUN_OUTLINE_DOWN:
211 case LFUN_OUTLINE_IN:
212 case LFUN_OUTLINE_OUT:
213 outline(cmd.action());
218 inset->dispatch(cur, tmpcmd);
224 void TocWidget::on_tocTV_activated(QModelIndex const & index)
230 void TocWidget::on_tocTV_pressed(QModelIndex const & index)
232 Qt::MouseButtons const button = QApplication::mouseButtons();
233 if (button & Qt::LeftButton) {
235 gui_view_.setFocus();
240 void TocWidget::goTo(QModelIndex const & index)
242 LYXERR(Debug::GUI, "goto " << index.row()
243 << ", " << index.column());
245 gui_view_.tocModels().goTo(current_type_, index);
249 void TocWidget::on_updateTB_clicked()
251 // The backend update can take some time so we disable
252 // the controls while waiting.
253 enableControls(false);
254 gui_view_.currentBufferView()->buffer().updateBuffer();
258 void TocWidget::on_sortCB_stateChanged(int state)
260 gui_view_.tocModels().sort(current_type_, state == Qt::Checked);
265 void TocWidget::on_persistentCB_stateChanged(int state)
267 persistent_ = state == Qt::Checked;
272 /* FIXME (Ugras 17/11/06):
273 I have implemented a indexDepth function to get the model indices. In my
274 opinion, somebody should derive a new qvariant class for tocModelItem
275 which saves the string data and depth information. That will save the
276 depth calculation. */
278 static int indexDepth(QModelIndex const & index, int depth = -1)
281 return index.parent() == QModelIndex()
282 ? depth : indexDepth(index.parent(), depth);
286 void TocWidget::on_depthSL_valueChanged(int depth)
291 gui_view_.setFocus();
295 void TocWidget::setTreeDepth(int depth)
302 tocTV->collapseAll();
304 tocTV->expandToDepth(depth - 1);
308 void TocWidget::on_typeCO_currentIndexChanged(int index)
312 current_type_ = typeCO->itemData(index).toString();
314 if (typeCO->hasFocus())
315 gui_view_.setFocus();
319 void TocWidget::outline(FuncCode func_code)
321 QModelIndexList const & list = tocTV->selectionModel()->selectedIndexes();
324 enableControls(false);
326 dispatch(FuncRequest(func_code));
327 enableControls(true);
328 gui_view_.setFocus();
332 void TocWidget::on_moveUpTB_clicked()
334 outline(LFUN_OUTLINE_UP);
338 void TocWidget::on_moveDownTB_clicked()
340 outline(LFUN_OUTLINE_DOWN);
344 void TocWidget::on_moveInTB_clicked()
346 outline(LFUN_OUTLINE_IN);
350 void TocWidget::on_moveOutTB_clicked()
352 outline(LFUN_OUTLINE_OUT);
356 void TocWidget::select(QModelIndex const & index)
358 if (!index.isValid()) {
359 LYXERR(Debug::GUI, "TocWidget::select(): QModelIndex is invalid!");
363 tocTV->scrollTo(index);
364 tocTV->clearSelection();
365 tocTV->setCurrentIndex(index);
369 void TocWidget::enableControls(bool enable)
371 updateTB->setEnabled(enable);
376 moveUpTB->setEnabled(enable);
377 moveDownTB->setEnabled(enable);
378 moveInTB->setEnabled(enable);
379 moveOutTB->setEnabled(enable);
383 void TocWidget::updateView()
385 // Enable if you dont want the delaying business, cf #7138.
386 #ifndef DELAY_UPDATE_VIEW
390 // already scheduled?
391 if (update_delay_ == -1)
393 QTimer::singleShot(update_delay_, this, SLOT(updateViewForce()));
394 // Subtler optimization for having the delay more UI invisible.
395 // We trigger update immediately for sparse editation actions,
396 // i.e. there was no editation/cursor movement in last 2 sec.
397 // At worst there will be +1 redraw after 2s in a such "calm" mode.
398 if (update_delay_ != 0)
403 void TocWidget::updateViewForce()
405 update_delay_ = 2000;
406 if (!gui_view_.documentBufferView()) {
408 depthSL->setMaximum(0);
409 depthSL->setValue(0);
414 bool const is_sortable = isSortable();
415 sortCB->setEnabled(is_sortable);
416 bool focus_ = tocTV->hasFocus();
417 tocTV->setEnabled(false);
418 tocTV->setUpdatesEnabled(false);
420 QAbstractItemModel * toc_model =
421 gui_view_.tocModels().model(current_type_);
422 if (tocTV->model() != toc_model) {
423 tocTV->setModel(toc_model);
424 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
426 setTreeDepth(depth_);
429 sortCB->blockSignals(true);
430 sortCB->setChecked(is_sortable
431 && gui_view_.tocModels().isSorted(current_type_));
432 sortCB->blockSignals(false);
434 bool const can_navigate_ = canNavigate();
435 persistentCB->setEnabled(can_navigate_);
437 bool controls_enabled = toc_model && toc_model->rowCount() > 0
438 && !gui_view_.documentBufferView()->buffer().isReadonly();
439 enableControls(controls_enabled);
441 depthSL->setMaximum(gui_view_.tocModels().depth(current_type_));
442 depthSL->setValue(depth_);
443 if (!persistent_ && can_navigate_)
444 setTreeDepth(depth_);
446 persistentCB->setChecked(persistent_);
447 select(gui_view_.tocModels().currentIndex(current_type_));
450 tocTV->setEnabled(true);
451 tocTV->setUpdatesEnabled(true);
457 void TocWidget::filterContents()
462 QModelIndexList indices = tocTV->model()->match(
463 tocTV->model()->index(0, 0),
464 Qt::DisplayRole, "*", -1,
465 Qt::MatchFlags(Qt::MatchWildcard|Qt::MatchRecursive));
467 int size = indices.size();
468 for (int i = 0; i < size; i++) {
469 QModelIndex index = indices[i];
471 index.data().toString().contains(
472 filterLE->text(), Qt::CaseInsensitive);
473 tocTV->setRowHidden(index.row(), index.parent(), !matches);
475 // recursively unhide parents of unhidden children
476 for (int i = size - 1; i >= 0; i--) {
477 QModelIndex index = indices[i];
478 if (!tocTV->isRowHidden(index.row(), index.parent())
479 && index.parent() != QModelIndex())
480 tocTV->setRowHidden(index.parent().row(),
481 index.parent().parent(), false);
486 static QString decodeType(QString const & str)
489 if (type.contains("tableofcontents"))
490 type = "tableofcontents";
491 else if (type.contains("lstlistoflistings"))
493 else if (type.contains("floatlist")) {
494 if (type.contains("\"figure"))
496 else if (type.contains("\"table"))
498 else if (type.contains("\"algorithm"))
505 void TocWidget::init(QString const & str)
509 new_index = typeCO->findData(current_type_);
511 new_index = typeCO->findData(decodeType(str));
513 // If everything else fails, settle on the table of contents which is
514 // guaranteed to exist.
515 if (new_index == -1) {
516 current_type_ = "tableofcontents";
517 new_index = typeCO->findData(current_type_);
519 current_type_ = typeCO->itemData(new_index).toString();
522 typeCO->blockSignals(true);
523 typeCO->setCurrentIndex(new_index);
524 typeCO->blockSignals(false);
526 // no delay when the whole outliner is reseted.
530 } // namespace frontend
533 #include "moc_TocWidget.cpp"