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(true);
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;
265 /* FIXME (Ugras 17/11/06):
266 I have implemented a indexDepth function to get the model indices. In my
267 opinion, somebody should derive a new qvariant class for tocModelItem
268 which saves the string data and depth information. That will save the
269 depth calculation. */
271 static int indexDepth(QModelIndex const & index, int depth = -1)
274 return index.parent() == QModelIndex()
275 ? depth : indexDepth(index.parent(), depth);
279 void TocWidget::on_depthSL_valueChanged(int depth)
284 gui_view_.setFocus();
288 void TocWidget::setTreeDepth(int depth)
294 #if QT_VERSION >= 0x040300
295 // this should be faster than our own code below
297 tocTV->collapseAll();
299 tocTV->expandToDepth(depth - 1);
301 // expanding and then collapsing is probably better,
302 // but my qt 4.1.2 doesn't have expandAll()..
303 //tocTV->expandAll();
304 QModelIndexList indices = tocTV->model()->match(
305 tocTV->model()->index(0, 0),
306 Qt::DisplayRole, "*", -1,
307 Qt::MatchFlags(Qt::MatchWildcard|Qt::MatchRecursive));
309 int size = indices.size();
310 for (int i = 0; i < size; i++) {
311 QModelIndex index = indices[i];
312 tocTV->setExpanded(index, indexDepth(index) < depth_);
318 void TocWidget::on_typeCO_currentIndexChanged(int index)
322 current_type_ = typeCO->itemData(index).toString();
324 if (typeCO->hasFocus())
325 gui_view_.setFocus();
329 void TocWidget::outline(FuncCode func_code)
331 QModelIndexList const & list = tocTV->selectionModel()->selectedIndexes();
334 enableControls(false);
336 dispatch(FuncRequest(func_code));
337 enableControls(true);
338 gui_view_.setFocus();
342 void TocWidget::on_moveUpTB_clicked()
344 outline(LFUN_OUTLINE_UP);
348 void TocWidget::on_moveDownTB_clicked()
350 outline(LFUN_OUTLINE_DOWN);
354 void TocWidget::on_moveInTB_clicked()
356 outline(LFUN_OUTLINE_IN);
360 void TocWidget::on_moveOutTB_clicked()
362 outline(LFUN_OUTLINE_OUT);
366 void TocWidget::select(QModelIndex const & index)
368 if (!index.isValid()) {
369 LYXERR(Debug::GUI, "TocWidget::select(): QModelIndex is invalid!");
373 tocTV->scrollTo(index);
374 tocTV->clearSelection();
375 tocTV->setCurrentIndex(index);
379 void TocWidget::enableControls(bool enable)
381 updateTB->setEnabled(enable);
386 moveUpTB->setEnabled(enable);
387 moveDownTB->setEnabled(enable);
388 moveInTB->setEnabled(enable);
389 moveOutTB->setEnabled(enable);
393 void TocWidget::updateView()
395 // Enable if you dont want the delaying business, cf #7138.
396 #ifndef DELAY_UPDATE_VIEW
400 // already scheduled?
401 if (update_delay_ == -1)
403 QTimer::singleShot(update_delay_, this, SLOT(updateViewForce()));
404 // Subtler optimization for having the delay more UI invisible.
405 // We trigger update immediately for sparse editation actions,
406 // i.e. there was no editation/cursor movement in last 2 sec.
407 // At worst there will be +1 redraw after 2s in a such "calm" mode.
408 if (update_delay_ != 0)
413 void TocWidget::updateViewForce()
415 update_delay_ = 2000;
416 if (!gui_view_.documentBufferView()) {
418 depthSL->setMaximum(0);
419 depthSL->setValue(0);
424 bool const is_sortable = isSortable();
425 sortCB->setEnabled(is_sortable);
426 bool focus_ = tocTV->hasFocus();
427 tocTV->setEnabled(false);
428 tocTV->setUpdatesEnabled(false);
430 QAbstractItemModel * toc_model =
431 gui_view_.tocModels().model(current_type_);
432 if (tocTV->model() != toc_model) {
433 tocTV->setModel(toc_model);
434 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
436 setTreeDepth(depth_);
439 sortCB->blockSignals(true);
440 sortCB->setChecked(is_sortable
441 && gui_view_.tocModels().isSorted(current_type_));
442 sortCB->blockSignals(false);
444 bool const can_navigate_ = canNavigate();
445 persistentCB->setEnabled(can_navigate_);
447 bool controls_enabled = toc_model && toc_model->rowCount() > 0
448 && !gui_view_.documentBufferView()->buffer().isReadonly();
449 enableControls(controls_enabled);
451 depthSL->setMaximum(gui_view_.tocModels().depth(current_type_));
452 depthSL->setValue(depth_);
453 if (!persistent_ && can_navigate_)
454 setTreeDepth(depth_);
456 persistentCB->setChecked(persistent_);
457 select(gui_view_.tocModels().currentIndex(current_type_));
460 tocTV->setEnabled(true);
461 tocTV->setUpdatesEnabled(true);
467 void TocWidget::filterContents()
472 QModelIndexList indices = tocTV->model()->match(
473 tocTV->model()->index(0, 0),
474 Qt::DisplayRole, "*", -1,
475 Qt::MatchFlags(Qt::MatchWildcard|Qt::MatchRecursive));
477 int size = indices.size();
478 for (int i = 0; i < size; i++) {
479 QModelIndex index = indices[i];
481 index.data().toString().contains(
482 filterLE->text(), Qt::CaseInsensitive);
483 tocTV->setRowHidden(index.row(), index.parent(), !matches);
485 // recursively unhide parents of unhidden children
486 for (int i = size - 1; i >= 0; i--) {
487 QModelIndex index = indices[i];
488 if (!tocTV->isRowHidden(index.row(), index.parent())
489 && index.parent() != QModelIndex())
490 tocTV->setRowHidden(index.parent().row(),
491 index.parent().parent(), false);
496 static QString decodeType(QString const & str)
499 if (type.contains("tableofcontents"))
500 type = "tableofcontents";
501 else if (type.contains("lstlistoflistings"))
503 else if (type.contains("floatlist")) {
504 if (type.contains("\"figure"))
506 else if (type.contains("\"table"))
508 else if (type.contains("\"algorithm"))
515 void TocWidget::init(QString const & str)
519 new_index = typeCO->findData(current_type_);
521 new_index = typeCO->findData(decodeType(str));
523 // If everything else fails, settle on the table of contents which is
524 // guaranteed to exist.
525 if (new_index == -1) {
526 current_type_ = "tableofcontents";
527 new_index = typeCO->findData(current_type_);
529 current_type_ = typeCO->itemData(new_index).toString();
532 typeCO->blockSignals(true);
533 typeCO->setCurrentIndex(new_index);
534 typeCO->blockSignals(false);
536 // no delay when the whole outliner is reseted.
540 } // namespace frontend
543 #include "moc_TocWidget.cpp"