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 "CutAndPaste.h"
23 #include "FuncRequest.h"
24 #include "FuncStatus.h"
27 #include "TocBackend.h"
29 #include "insets/InsetCommand.h"
30 #include "insets/InsetRef.h"
32 #include "support/debug.h"
33 #include "support/lassert.h"
35 #include <QHeaderView>
46 TocWidget::TocWidget(GuiView & gui_view, QWidget * parent)
47 : QWidget(parent), depth_(0), persistent_(false), gui_view_(gui_view)
51 moveOutTB->setIcon(QIcon(getPixmap("images/", "promote", "png")));
52 moveInTB->setIcon(QIcon(getPixmap("images/", "demote", "png")));
53 moveUpTB->setIcon(QIcon(getPixmap("images/", "up", "png")));
54 moveDownTB->setIcon(QIcon(getPixmap("images/", "down", "png")));
55 updateTB->setIcon(QIcon(getPixmap("images/", "reload", "png")));
58 tocTV->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
62 // hide the pointless QHeader for now
63 // in the future, new columns may appear
64 // like labels, bookmarks, etc...
65 // tocTV->header()->hide();
66 tocTV->header()->setVisible(false);
68 // Only one item selected at a time.
69 tocTV->setSelectionMode(QAbstractItemView::SingleSelection);
71 // The toc types combo won't change its model.
72 typeCO->setModel(gui_view_.tocModels().nameModel());
74 // Make sure the buttons are disabled when first shown without a loaded
76 enableControls(false);
78 // make us responsible for the context menu of the tabbar
79 setContextMenuPolicy(Qt::CustomContextMenu);
80 connect(this, SIGNAL(customContextMenuRequested(const QPoint &)),
81 this, SLOT(showContextMenu(const QPoint &)));
82 connect(tocTV, SIGNAL(customContextMenuRequested(const QPoint &)),
83 this, SLOT(showContextMenu(const QPoint &)));
89 void TocWidget::showContextMenu(const QPoint & pos)
91 std::string name = "context-toc-" + fromqstr(current_type_);
92 QMenu * menu = guiApp->menus().menu(toqstr(name), gui_view_);
95 menu->exec(mapToGlobal(pos));
99 Inset * TocWidget::itemInset() const
101 QModelIndex const & index = tocTV->currentIndex();
102 TocItem const & item =
103 gui_view_.tocModels().currentItem(current_type_, index);
104 DocIterator const & dit = item.dit();
107 if (current_type_ == "label"
108 || current_type_ == "graphics"
109 || current_type_ == "citation")
110 inset = dit.nextInset();
112 else if (current_type_ == "branch")
113 inset = &dit.inset();
115 else if (current_type_ == "table" || current_type_ == "figure") {
116 DocIterator tmp_dit(dit);
118 inset = &tmp_dit.inset();
124 bool TocWidget::getStatus(Cursor & cur, FuncRequest const & cmd,
125 FuncStatus & status) const
127 Inset * inset = itemInset();
129 FuncRequest tmpcmd(cmd);
131 return inset->getStatus(cur, tmpcmd, status);
136 void TocWidget::doDispatch(Cursor & cur, FuncRequest const & cmd)
138 Inset * inset = itemInset();
140 FuncRequest tmpcmd(cmd);
142 inset->dispatch(cur, tmpcmd);
146 void TocWidget::on_tocTV_activated(QModelIndex const & index)
152 void TocWidget::on_tocTV_pressed(QModelIndex const & index)
154 Qt::MouseButtons const button = QApplication::mouseButtons();
155 if (button & Qt::LeftButton) {
157 gui_view_.setFocus();
162 void TocWidget::goTo(QModelIndex const & index)
164 LYXERR(Debug::GUI, "goto " << index.row()
165 << ", " << index.column());
167 gui_view_.tocModels().goTo(current_type_, index);
171 void TocWidget::on_updateTB_clicked()
173 // The backend update can take some time so we disable
174 // the controls while waiting.
175 enableControls(false);
176 gui_view_.tocModels().updateBackend();
180 void TocWidget::on_sortCB_stateChanged(int state)
182 gui_view_.tocModels().sort(current_type_, state == Qt::Checked);
186 void TocWidget::on_persistentCB_stateChanged(int state)
188 persistent_ = state == Qt::Checked;
192 /* FIXME (Ugras 17/11/06):
193 I have implemented a indexDepth function to get the model indices. In my
194 opinion, somebody should derive a new qvariant class for tocModelItem
195 which saves the string data and depth information. That will save the
196 depth calculation. */
198 static int indexDepth(QModelIndex const & index, int depth = -1)
201 return index.parent() == QModelIndex()
202 ? depth : indexDepth(index.parent(), depth);
206 void TocWidget::on_depthSL_valueChanged(int depth)
211 gui_view_.setFocus();
215 void TocWidget::setTreeDepth(int depth)
221 #if QT_VERSION >= 0x040300
222 // this should be faster than our own code below
224 tocTV->collapseAll();
226 tocTV->expandToDepth(depth - 1);
228 // expanding and then collapsing is probably better,
229 // but my qt 4.1.2 doesn't have expandAll()..
230 //tocTV->expandAll();
231 QModelIndexList indices = tocTV->model()->match(
232 tocTV->model()->index(0, 0),
233 Qt::DisplayRole, "*", -1,
234 Qt::MatchFlags(Qt::MatchWildcard|Qt::MatchRecursive));
236 int size = indices.size();
237 for (int i = 0; i < size; i++) {
238 QModelIndex index = indices[i];
239 tocTV->setExpanded(index, indexDepth(index) < depth_);
245 void TocWidget::on_typeCO_currentIndexChanged(int index)
247 current_type_ = typeCO->itemData(index).toString();
249 gui_view_.setFocus();
253 void TocWidget::outline(int func_code)
255 enableControls(false);
256 QModelIndexList const & list = tocTV->selectionModel()->selectedIndexes();
259 enableControls(false);
261 dispatch(FuncRequest(static_cast<FuncCode>(func_code)));
262 enableControls(true);
263 gui_view_.setFocus();
267 void TocWidget::on_moveUpTB_clicked()
269 outline(LFUN_OUTLINE_UP);
273 void TocWidget::on_moveDownTB_clicked()
275 outline(LFUN_OUTLINE_DOWN);
279 void TocWidget::on_moveInTB_clicked()
281 outline(LFUN_OUTLINE_IN);
285 void TocWidget::on_moveOutTB_clicked()
287 outline(LFUN_OUTLINE_OUT);
291 void TocWidget::select(QModelIndex const & index)
293 if (!index.isValid()) {
294 LYXERR(Debug::GUI, "TocWidget::select(): QModelIndex is invalid!");
298 tocTV->scrollTo(index);
299 tocTV->clearSelection();
300 tocTV->setCurrentIndex(index);
304 /// Test if outlining operation is possible
305 static bool canOutline(QString const & type)
307 return type == "tableofcontents";
311 void TocWidget::enableControls(bool enable)
313 updateTB->setEnabled(enable);
315 if (!canOutline(current_type_))
318 moveUpTB->setEnabled(enable);
319 moveDownTB->setEnabled(enable);
320 moveInTB->setEnabled(enable);
321 moveOutTB->setEnabled(enable);
323 depthSL->setMaximum(0);
324 depthSL->setValue(0);
329 /// Test if synchronized navigation is possible
330 static bool canNavigate(QString const & type)
332 // It is not possible to have synchronous navigation in a correctl
333 // and efficient way with the label type because Toc::item() do a linear
334 // seatch. Even if fixed, it might even not be desirable to do so if we
335 // want to support drag&drop of labels and references.
336 return type != "label" && type != "change";
340 void TocWidget::updateView()
342 if (!gui_view_.view()) {
343 enableControls(false);
344 typeCO->setEnabled(false);
346 tocTV->setEnabled(false);
349 typeCO->setEnabled(true);
350 tocTV->setEnabled(false);
351 tocTV->setUpdatesEnabled(false);
353 QAbstractItemModel * toc_model = gui_view_.tocModels().model(current_type_);
354 if (tocTV->model() != toc_model) {
355 tocTV->setModel(toc_model);
356 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
358 setTreeDepth(depth_);
361 sortCB->blockSignals(true);
362 sortCB->setChecked(gui_view_.tocModels().isSorted(current_type_));
363 sortCB->blockSignals(false);
365 persistentCB->setChecked(persistent_);
367 bool controls_enabled = toc_model && toc_model->rowCount() > 0
368 && !gui_view_.buffer()->isReadonly();
369 enableControls(controls_enabled);
371 depthSL->setMaximum(gui_view_.tocModels().depth(current_type_));
372 depthSL->setValue(depth_);
374 setTreeDepth(depth_);
375 if (canNavigate(current_type_))
376 select(gui_view_.tocModels().currentIndex(current_type_));
377 tocTV->setEnabled(true);
378 tocTV->setUpdatesEnabled(true);
382 static QString decodeType(QString const & str)
385 if (type.contains("tableofcontents")) {
386 type = "tableofcontents";
387 } else if (type.contains("floatlist")) {
388 if (type.contains("\"figure"))
390 else if (type.contains("\"table"))
392 else if (type.contains("\"algorithm"))
399 void TocWidget::init(QString const & str)
403 new_index = typeCO->findData(current_type_);
405 new_index = typeCO->findData(decodeType(str));
407 // If everything else fails, settle on the table of contents which is
408 // guaranted to exist.
409 if (new_index == -1) {
410 current_type_ = "tableofcontents";
411 new_index = typeCO->findData(current_type_);
413 current_type_ = typeCO->itemData(new_index).toString();
416 typeCO->blockSignals(true);
417 typeCO->setCurrentIndex(new_index);
418 typeCO->blockSignals(false);
421 } // namespace frontend
424 #include "moc_TocWidget.cpp"