3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Abdelrazak Younes
8 * \author Angus Leeming
10 * Full author contact details are available in file CREDITS.
18 #include "TocWidget.h"
19 #include "FuncRequest.h"
20 #include "insets/InsetCommand.h"
23 #include "qt_helpers.h"
26 #include "BufferView.h"
27 #include "BufferParams.h"
28 #include "support/debug.h"
29 #include "FloatList.h"
30 #include "FuncRequest.h"
31 #include "support/gettext.h"
32 #include "TextClass.h"
34 #include "support/convert.h"
43 GuiToc::GuiToc(GuiView & parent, Qt::DockWidgetArea area, Qt::WindowFlags flags)
44 : DockView(parent, "toc", qt_("Outline"), area, flags), params_(TOC_CODE)
46 widget_ = new TocWidget(*this);
58 void GuiToc::clearTocModels()
60 const unsigned int size = toc_models_.size();
61 for (unsigned int i = 0; i < size; ++i) {
62 delete toc_models_[i];
68 int GuiToc::getTocDepth(int type)
72 return toc_models_[type]->modelDepth();
76 QStandardItemModel * GuiToc::tocModel(int type)
81 if (toc_models_.empty()) {
82 LYXERR(Debug::GUI, "GuiToc::tocModel(): no types available ");
86 LYXERR(Debug::GUI, "GuiToc: type " << type
87 << " toc_models_.size() " << toc_models_.size());
89 BOOST_ASSERT(type >= 0 && type < int(toc_models_.size()));
90 return toc_models_[type];
94 QModelIndex GuiToc::currentIndex(int type) const
99 // FIXME: The TocBackend infrastructure is not ready for LOF and LOT
100 // This is because a proper ParConstIterator is not constructed in
101 // InsetCaption::addToToc()
102 if(!canOutline(type))
103 return QModelIndex();
105 return toc_models_[type]->modelIndex(currentTocItem(type));
109 void GuiToc::goTo(int type, QModelIndex const & index)
111 if (type < 0 || !index.isValid()
112 || index.model() != toc_models_[type]) {
113 LYXERR(Debug::GUI, "GuiToc::goTo(): QModelIndex is invalid!");
117 BOOST_ASSERT(type >= 0 && type < int(toc_models_.size()));
119 TocIterator const it = toc_models_[type]->tocIterator(index);
121 LYXERR(Debug::GUI, "GuiToc::goTo " << to_utf8(it->str()));
123 string const tmp = convert<string>(it->id());
124 dispatch(FuncRequest(LFUN_PARAGRAPH_GOTO, tmp));
128 void GuiToc::updateView()
130 widget_->updateView();
134 TocList const & GuiToc::tocs() const
136 return buffer().masterBuffer()->tocBackend().tocs();
140 bool GuiToc::initialiseParams(string const & data)
142 InsetCommandMailer::string2params("toc", data, params_);
147 TocList const & tocs = buffer().masterBuffer()->tocBackend().tocs();
148 TocList::const_iterator it = tocs.begin();
149 TocList::const_iterator end = tocs.end();
150 for (; it != end; ++it) {
151 types_.push_back(it->first);
152 type_names_.push_back(guiName(it->first));
153 toc_models_.push_back(new TocModel(it->second));
156 string selected_type ;
157 if (params_["type"].empty()) //Then plain toc...
158 selected_type = params_.getCmdName();
160 selected_type = to_ascii(params_["type"]);
162 for (size_t i = 0; i != types_.size(); ++i) {
163 if (selected_type == types_[i]) {
174 bool GuiToc::canOutline(int type) const
176 return types_[type] == "tableofcontents";
180 void GuiToc::outlineUp()
182 dispatch(FuncRequest(LFUN_OUTLINE_UP));
186 void GuiToc::outlineDown()
188 dispatch(FuncRequest(LFUN_OUTLINE_DOWN));
192 void GuiToc::outlineIn()
194 dispatch(FuncRequest(LFUN_OUTLINE_IN));
198 void GuiToc::outlineOut()
200 dispatch(FuncRequest(LFUN_OUTLINE_OUT));
204 void GuiToc::updateBackend()
206 buffer().masterBuffer()->tocBackend().update();
207 buffer().structureChanged();
211 TocIterator GuiToc::currentTocItem(int type) const
213 BOOST_ASSERT(bufferview());
214 ParConstIterator it(bufferview()->cursor());
215 return buffer().masterBuffer()->tocBackend().item(types_[type], it);
219 docstring GuiToc::guiName(string const & type) const
221 if (type == "tableofcontents")
222 return _("Table of Contents");
224 FloatList const & floats = buffer().params().getTextClass().floats();
225 if (floats.typeExist(type))
226 return _(floats.getType(type).listName());
232 void GuiToc::dispatchParams()
235 InsetCommandMailer::params2string("toc", params_);
236 dispatch(FuncRequest(getLfun(), lfun));
240 Dialog * createGuiToc(GuiView & lv)
242 GuiView & guiview = static_cast<GuiView &>(lv);
244 // On Mac show as a drawer at the right
245 return new GuiToc(guiview, Qt::RightDockWidgetArea, Qt::Drawer);
247 return new GuiToc(guiview);
252 } // namespace frontend
255 #include "GuiToc_moc.cpp"