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"
26 #include "TocBackend.h"
28 #include "insets/InsetCommand.h"
29 #include "insets/InsetRef.h"
31 #include "support/debug.h"
32 #include "support/lassert.h"
34 #include <QHeaderView>
45 TocWidget::TocWidget(GuiView & gui_view, QWidget * parent)
46 : QWidget(parent), depth_(0), persistent_(false), gui_view_(gui_view)
50 moveOutTB->setIcon(QIcon(getPixmap("images/", "promote", "png")));
51 moveInTB->setIcon(QIcon(getPixmap("images/", "demote", "png")));
52 moveUpTB->setIcon(QIcon(getPixmap("images/", "up", "png")));
53 moveDownTB->setIcon(QIcon(getPixmap("images/", "down", "png")));
54 updateTB->setIcon(QIcon(getPixmap("images/", "reload", "png")));
57 tocTV->setVerticalScrollBarPolicy(Qt::ScrollBarAlwaysOn);
61 // hide the pointless QHeader for now
62 // in the future, new columns may appear
63 // like labels, bookmarks, etc...
64 // tocTV->header()->hide();
65 tocTV->header()->setVisible(false);
67 // Only one item selected at a time.
68 tocTV->setSelectionMode(QAbstractItemView::SingleSelection);
70 // The toc types combo won't change its model.
71 typeCO->setModel(gui_view_.tocModels().nameModel());
73 // Make sure the buttons are disabled when first shown without a loaded
75 enableControls(false);
77 // make us responsible for the context menu of the tabbar
78 setContextMenuPolicy(Qt::CustomContextMenu);
79 connect(this, SIGNAL(customContextMenuRequested(const QPoint &)),
80 this, SLOT(showContextMenu(const QPoint &)));
81 connect(tocTV, SIGNAL(customContextMenuRequested(const QPoint &)),
82 this, SLOT(showContextMenu(const QPoint &)));
88 void TocWidget::showContextMenu(const QPoint & pos)
90 std::string name = "context-toc-" + fromqstr(current_type_);
91 QMenu * menu = guiApp->menus().menu(toqstr(name), gui_view_);
94 menu->exec(mapToGlobal(pos));
98 void TocWidget::doDispatch(Cursor & cur, FuncRequest const & cmd)
100 QModelIndex const & index = tocTV->currentIndex();
101 TocItem const & item =
102 gui_view_.tocModels().currentItem(current_type_, index);
103 DocIterator const & dit = item.dit();
106 if (current_type_ == "label")
107 inset = dit.nextInset();
110 inset->dispatch(cur, FuncRequest(cmd));
114 void TocWidget::on_tocTV_activated(QModelIndex const & index)
120 void TocWidget::on_tocTV_pressed(QModelIndex const & index)
122 Qt::MouseButtons const button = QApplication::mouseButtons();
123 if (button & Qt::LeftButton) {
125 gui_view_.setFocus();
130 void TocWidget::goTo(QModelIndex const & index)
132 LYXERR(Debug::GUI, "goto " << index.row()
133 << ", " << index.column());
135 gui_view_.tocModels().goTo(current_type_, index);
139 void TocWidget::on_updateTB_clicked()
141 // The backend update can take some time so we disable
142 // the controls while waiting.
143 enableControls(false);
144 gui_view_.tocModels().updateBackend();
148 void TocWidget::on_sortCB_stateChanged(int state)
150 gui_view_.tocModels().sort(current_type_, state == Qt::Checked);
154 void TocWidget::on_persistentCB_stateChanged(int state)
156 persistent_ = state == Qt::Checked;
160 /* FIXME (Ugras 17/11/06):
161 I have implemented a indexDepth function to get the model indices. In my
162 opinion, somebody should derive a new qvariant class for tocModelItem
163 which saves the string data and depth information. That will save the
164 depth calculation. */
166 static int indexDepth(QModelIndex const & index, int depth = -1)
169 return index.parent() == QModelIndex()
170 ? depth : indexDepth(index.parent(), depth);
174 void TocWidget::on_depthSL_valueChanged(int depth)
179 gui_view_.setFocus();
183 void TocWidget::setTreeDepth(int depth)
189 #if QT_VERSION >= 0x040300
190 // this should be faster than our own code below
192 tocTV->collapseAll();
194 tocTV->expandToDepth(depth - 1);
196 // expanding and then collapsing is probably better,
197 // but my qt 4.1.2 doesn't have expandAll()..
198 //tocTV->expandAll();
199 QModelIndexList indices = tocTV->model()->match(
200 tocTV->model()->index(0, 0),
201 Qt::DisplayRole, "*", -1,
202 Qt::MatchFlags(Qt::MatchWildcard|Qt::MatchRecursive));
204 int size = indices.size();
205 for (int i = 0; i < size; i++) {
206 QModelIndex index = indices[i];
207 tocTV->setExpanded(index, indexDepth(index) < depth_);
213 void TocWidget::on_typeCO_currentIndexChanged(int index)
215 current_type_ = typeCO->itemData(index).toString();
217 gui_view_.setFocus();
221 void TocWidget::outline(int func_code)
223 enableControls(false);
224 QModelIndexList const & list = tocTV->selectionModel()->selectedIndexes();
227 enableControls(false);
229 dispatch(FuncRequest(static_cast<FuncCode>(func_code)));
230 enableControls(true);
231 gui_view_.setFocus();
235 void TocWidget::on_moveUpTB_clicked()
237 outline(LFUN_OUTLINE_UP);
241 void TocWidget::on_moveDownTB_clicked()
243 outline(LFUN_OUTLINE_DOWN);
247 void TocWidget::on_moveInTB_clicked()
249 outline(LFUN_OUTLINE_IN);
253 void TocWidget::on_moveOutTB_clicked()
255 outline(LFUN_OUTLINE_OUT);
259 void TocWidget::select(QModelIndex const & index)
261 if (!index.isValid()) {
262 LYXERR(Debug::GUI, "TocWidget::select(): QModelIndex is invalid!");
266 tocTV->scrollTo(index);
267 tocTV->clearSelection();
268 tocTV->setCurrentIndex(index);
272 /// Test if outlining operation is possible
273 static bool canOutline(QString const & type)
275 return type == "tableofcontents";
279 void TocWidget::enableControls(bool enable)
281 updateTB->setEnabled(enable);
283 if (!canOutline(current_type_))
286 moveUpTB->setEnabled(enable);
287 moveDownTB->setEnabled(enable);
288 moveInTB->setEnabled(enable);
289 moveOutTB->setEnabled(enable);
291 depthSL->setMaximum(0);
292 depthSL->setValue(0);
297 /// Test if synchronized navigation is possible
298 static bool canNavigate(QString const & type)
300 // It is not possible to have synchronous navigation in a correctl
301 // and efficient way with the label type because Toc::item() do a linear
302 // seatch. Even if fixed, it might even not be desirable to do so if we
303 // want to support drag&drop of labels and references.
304 return type != "label" && type != "change";
308 void TocWidget::updateView()
310 if (!gui_view_.view()) {
311 enableControls(false);
312 typeCO->setEnabled(false);
314 tocTV->setEnabled(false);
317 typeCO->setEnabled(true);
318 tocTV->setEnabled(false);
319 tocTV->setUpdatesEnabled(false);
321 QAbstractItemModel * toc_model = gui_view_.tocModels().model(current_type_);
322 if (tocTV->model() != toc_model) {
323 tocTV->setModel(toc_model);
324 tocTV->setEditTriggers(QAbstractItemView::NoEditTriggers);
326 setTreeDepth(depth_);
329 sortCB->blockSignals(true);
330 sortCB->setChecked(gui_view_.tocModels().isSorted(current_type_));
331 sortCB->blockSignals(false);
333 persistentCB->setChecked(persistent_);
335 bool controls_enabled = toc_model && toc_model->rowCount() > 0
336 && !gui_view_.buffer()->isReadonly();
337 enableControls(controls_enabled);
339 depthSL->setMaximum(gui_view_.tocModels().depth(current_type_));
340 depthSL->setValue(depth_);
342 setTreeDepth(depth_);
343 if (canNavigate(current_type_))
344 select(gui_view_.tocModels().currentIndex(current_type_));
345 tocTV->setEnabled(true);
346 tocTV->setUpdatesEnabled(true);
350 static QString decodeType(QString const & str)
353 if (type.contains("tableofcontents")) {
354 type = "tableofcontents";
355 } else if (type.contains("floatlist")) {
356 if (type.contains("\"figure"))
358 else if (type.contains("\"table"))
360 else if (type.contains("\"algorithm"))
367 void TocWidget::init(QString const & str)
371 new_index = typeCO->findData(current_type_);
373 new_index = typeCO->findData(decodeType(str));
375 // If everything else fails, settle on the table of contents which is
376 // guaranted to exist.
377 if (new_index == -1) {
378 current_type_ = "tableofcontents";
379 new_index = typeCO->findData(current_type_);
381 current_type_ = typeCO->itemData(new_index).toString();
384 typeCO->blockSignals(true);
385 typeCO->setCurrentIndex(new_index);
386 typeCO->blockSignals(false);
389 } // namespace frontend
392 #include "moc_TocWidget.cpp"