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 "FloatList.h"
29 #include "FuncRequest.h"
30 #include "TextClass.h"
32 #include "support/convert.h"
33 #include "support/debug.h"
34 #include "support/gettext.h"
43 GuiToc::GuiToc(GuiView & parent, Qt::DockWidgetArea area, Qt::WindowFlags flags)
44 : DockView(parent, "toc", qt_("Outline"), area, flags)
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 return toc_models_[type]->modelIndex(currentTocItem(type));
103 void GuiToc::goTo(int type, QModelIndex const & index)
105 if (type < 0 || !index.isValid()
106 || index.model() != toc_models_[type]) {
107 LYXERR(Debug::GUI, "GuiToc::goTo(): QModelIndex is invalid!");
111 BOOST_ASSERT(type >= 0 && type < int(toc_models_.size()));
113 TocIterator const it = toc_models_[type]->tocIterator(index);
115 LYXERR(Debug::GUI, "GuiToc::goTo " << to_utf8(it->str()));
117 string const tmp = convert<string>(it->id());
118 dispatch(FuncRequest(LFUN_PARAGRAPH_GOTO, tmp));
122 void GuiToc::updateView()
124 widget_->updateView();
128 TocList const & GuiToc::tocs() const
130 return buffer().masterBuffer()->tocBackend().tocs();
134 bool GuiToc::initialiseParams(string const & data)
136 LYXERR(Debug::GUI, data);
137 QString str = QString::fromUtf8(data.c_str());
139 if (str.contains("tableofcontents"))
140 new_type = "tableofcontents";
141 else if (str.contains("floatlist")) {
142 if (str.contains("\"figure"))
144 else if (str.contains("\"table"))
146 else if (str.contains("\"algorithm"))
147 new_type = "algorithm";
153 TocList const & tocs = buffer().masterBuffer()->tocBackend().tocs();
154 TocList::const_iterator it = tocs.begin();
155 TocList::const_iterator end = tocs.end();
156 for (; it != end; ++it) {
157 types_.push_back(it->first);
158 type_names_.push_back(guiName(it->first));
159 toc_models_.push_back(new TocModel(it->second));
162 int selected_type = -1;
163 for (size_t i = 0; i != types_.size(); ++i) {
164 if (new_type == types_[i]) {
169 widget_->updateGui(selected_type);
175 bool GuiToc::canOutline(int type) const
177 return types_[type] == "tableofcontents";
181 void GuiToc::outlineUp()
183 dispatch(FuncRequest(LFUN_OUTLINE_UP));
187 void GuiToc::outlineDown()
189 dispatch(FuncRequest(LFUN_OUTLINE_DOWN));
193 void GuiToc::outlineIn()
195 dispatch(FuncRequest(LFUN_OUTLINE_IN));
199 void GuiToc::outlineOut()
201 dispatch(FuncRequest(LFUN_OUTLINE_OUT));
205 void GuiToc::updateBackend()
207 buffer().masterBuffer()->tocBackend().update();
208 buffer().structureChanged();
212 TocIterator GuiToc::currentTocItem(int type) const
214 BOOST_ASSERT(bufferview());
215 ParConstIterator it(bufferview()->cursor());
216 return buffer().masterBuffer()->tocBackend().item(types_[type], it);
220 docstring GuiToc::guiName(string const & type) const
222 if (type == "tableofcontents")
223 return _("Table of Contents");
224 if (type == "equation")
225 return _("List of Equations");
226 if (type == "footnote")
227 return _("List of Foot notes");
228 if (type == "listing")
229 return _("List of Listings");
231 return _("List of Indexes");
232 if (type == "marginalnote")
233 return _("List of Marginal notes");
235 return _("List of Notes");
237 FloatList const & floats = buffer().params().textClass().floats();
238 if (floats.typeExist(type))
239 return _(floats.getType(type).listName());
245 void GuiToc::dispatchParams()
250 Dialog * createGuiToc(GuiView & lv)
252 GuiView & guiview = static_cast<GuiView &>(lv);
254 // On Mac show as a drawer at the right
255 return new GuiToc(guiview, Qt::RightDockWidgetArea, Qt::Drawer);
257 return new GuiToc(guiview);
262 } // namespace frontend
265 #include "GuiToc_moc.cpp"