2 * \file GuiToolbars.cpp
3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
6 * \author Lars Gullik Bjønnes
7 * \author Angus Leeming
8 * \author Abdelrazak Younes
10 * Full author contact details are available in file CREDITS.
15 #include "GuiToolbars.h"
17 #include "GuiCommandBuffer.h"
18 #include "GuiToolbar.h"
22 #include "BufferParams.h"
24 #include "FuncRequest.h"
25 #include "FuncStatus.h"
30 #include "TextClass.h"
31 #include "ToolbarBackend.h"
40 #define TurnOnFlag(x) flags |= ToolbarInfo::x
41 #define TurnOffFlag(x) flags &= ~ToolbarInfo::x
43 GuiToolbars::GuiToolbars(GuiViewBase & owner)
46 last_textclass_(TextClassPtr())
50 void GuiToolbars::initFlags(ToolbarInfo & tbinfo)
52 ToolbarSection::ToolbarInfo & info = LyX::ref().session().toolbars().load(tbinfo.name);
54 unsigned int flags = static_cast<unsigned int>(tbinfo.flags);
56 // Remove default.ui positions. Only when a valid postion is stored
57 // in the session file the default.ui value will be overwritten
58 unsigned int save = flags;
64 bool valid_location = true;
65 // init tbinfo.flags with saved location
66 if (info.location == ToolbarSection::ToolbarInfo::TOP)
68 else if (info.location == ToolbarSection::ToolbarInfo::BOTTOM)
70 else if (info.location == ToolbarSection::ToolbarInfo::RIGHT)
72 else if (info.location == ToolbarSection::ToolbarInfo::LEFT)
75 // use setting from default.ui
77 valid_location = false;
80 // invalid location is for a new toolbar that has no saved information,
81 // so info.visible is not used for this case.
83 // init tbinfo.flags with saved visibility,
87 if (info.state == ToolbarSection::ToolbarInfo::ON)
89 else if (info.state == ToolbarSection::ToolbarInfo::OFF)
95 std::cout << "State " << info.state << " FLAGS: " << flags
96 << " ON:" << (flags & ToolbarBackend::ON)
97 << " OFF:" << (flags & ToolbarBackend::OFF)
98 << " L:" << (flags & ToolbarBackend::LEFT)
99 << " R:" << (flags & ToolbarBackend::RIGHT)
100 << " T:" << (flags & ToolbarBackend::TOP)
101 << " B:" << (flags & ToolbarBackend::BOTTOM)
102 << " MA:" << (flags & ToolbarBackend::MATH)
103 << " RE:" << (flags & ToolbarBackend::REVIEW)
104 << " TB:" << (flags & ToolbarBackend::TABLE)
105 << " AU:" << (flags & ToolbarBackend::AUTO)
109 tbinfo.flags = static_cast<lyx::ToolbarInfo::Flags>(flags);
113 void GuiToolbars::init()
115 // extracts the toolbars from the backend
116 ToolbarBackend::Toolbars::iterator cit = toolbarbackend.begin();
117 ToolbarBackend::Toolbars::iterator end = toolbarbackend.end();
119 // init flags will also add these toolbars to session if they
120 // are not already there (e.g. first run of lyx).
121 for (; cit != end; ++cit)
124 // add toolbars according the order in session
125 ToolbarSection::ToolbarList::const_iterator tb = LyX::ref().session().toolbars().begin();
126 ToolbarSection::ToolbarList::const_iterator te = LyX::ref().session().toolbars().end();
127 ToolbarSection::ToolbarInfo::Location last_loc = ToolbarSection::ToolbarInfo::NOTSET;
130 for (; tb != te; ++tb) {
131 LYXERR(Debug::INIT) << "Adding " << tb->get<0>() << " at position " << tb->get<1>().posx << " " << tb->get<1>().posy << endl;
132 // add toolbar break if posx or posy changes
133 bool newline = tb->get<1>().location == last_loc && (
134 // if two toolbars at the same location, assume uninitialized and add toolbar break
135 (tb->get<1>().posx == last_posx && tb->get<1>().posy == last_posy) ||
136 (last_loc == ToolbarSection::ToolbarInfo::TOP && tb->get<1>().posy != last_posy) ||
137 (last_loc == ToolbarSection::ToolbarInfo::BOTTOM && tb->get<1>().posy != last_posy) ||
138 (last_loc == ToolbarSection::ToolbarInfo::LEFT && tb->get<1>().posx != last_posx) ||
139 (last_loc == ToolbarSection::ToolbarInfo::RIGHT && tb->get<1>().posx != last_posx) );
140 // find the backend item and add
141 for (cit = toolbarbackend.begin(); cit != end; ++cit)
142 if (cit->name == tb->get<0>()) {
144 last_loc = tb->get<1>().location;
145 last_posx = tb->get<1>().posx;
146 last_posy = tb->get<1>().posy;
153 void GuiToolbars::display(string const & name, bool show)
155 ToolbarBackend::Toolbars::iterator cit = toolbarbackend.begin();
156 ToolbarBackend::Toolbars::iterator end = toolbarbackend.end();
158 for (; cit != end; ++cit) {
159 if (cit->name == name) {
160 unsigned int flags = cit->flags;
168 cit->flags = static_cast<lyx::ToolbarInfo::Flags>(flags);
169 displayToolbar(*cit, show);
173 LYXERR(Debug::GUI) << "Toolbar::display: no toolbar named "
178 ToolbarInfo * GuiToolbars::getToolbarInfo(string const & name)
180 return toolbarbackend.getUsedToolbarInfo(name);
184 void GuiToolbars::toggleToolbarState(string const & name, bool allowauto)
186 ToolbarInfo * tbi = toolbarbackend.getUsedToolbarInfo(name);
189 LYXERR(Debug::GUI) << "Toolbar::display: no toolbar named "
194 int flags = tbi->flags;
196 if (flags & ToolbarInfo::OFF) {
200 } else if (flags & ToolbarInfo::AUTO) {
204 && ((flags & ToolbarInfo::MATH)
205 || (flags & ToolbarInfo::TABLE)
206 || (flags & ToolbarInfo::REVIEW))) {
207 // for math etc, toggle from on -> auto
211 // for others, toggle from on -> off
215 tbi->flags = static_cast<ToolbarInfo::Flags>(flags);
221 void GuiToolbars::update(bool in_math, bool in_table, bool review)
225 // extracts the toolbars from the backend
226 ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
227 ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
229 for (; cit != end; ++cit) {
230 if (cit->flags & ToolbarInfo::ON)
231 displayToolbar(*cit, true);
232 else if (cit->flags & ToolbarInfo::OFF)
233 displayToolbar(*cit, false);
234 else if ((cit->flags & ToolbarInfo::AUTO) && (cit->flags & ToolbarInfo::MATH))
235 displayToolbar(*cit, in_math);
236 else if ((cit->flags & ToolbarInfo::AUTO) && (cit->flags & ToolbarInfo::TABLE))
237 displayToolbar(*cit, in_table);
238 else if ((cit->flags & ToolbarInfo::AUTO) && (cit->flags & ToolbarInfo::REVIEW))
239 displayToolbar(*cit, review);
244 bool GuiToolbars::visible(string const & name) const
246 std::map<string, GuiToolbar *>::const_iterator it =
247 toolbars_.find(name);
248 if (it == toolbars_.end())
250 return it->second->isVisible();
254 void GuiToolbars::saveToolbarInfo()
256 ToolbarSection & tb = LyX::ref().session().toolbars();
258 for (ToolbarBackend::Toolbars::iterator cit = toolbarbackend.begin();
259 cit != toolbarbackend.end(); ++cit) {
260 ToolbarsMap::iterator it = toolbars_.find(cit->name);
261 BOOST_ASSERT(it != toolbars_.end());
262 // get toolbar info from session.
263 ToolbarSection::ToolbarInfo & info = tb.load(cit->name);
264 if (cit->flags & ToolbarInfo::ON)
265 info.state = ToolbarSection::ToolbarInfo::ON;
266 else if (cit->flags & ToolbarInfo::OFF)
267 info.state = ToolbarSection::ToolbarInfo::OFF;
268 else if (cit->flags & ToolbarInfo::AUTO)
269 info.state = ToolbarSection::ToolbarInfo::AUTO;
270 // save other information
271 // if auto, frontend should *not* set on/off
272 it->second->saveInfo(info);
273 // maybe it is useful to update flags with real status. I do not know
275 if (!(cit->flags & ToolbarInfo::AUTO)) {
276 unsigned int flags = static_cast<unsigned int>(cit->flags);
277 flags &= ~(info.state == ToolbarSection::ToolbarInfo::ON ? ToolbarInfo::OFF : ToolbarInfo::ON);
278 flags |= (info.state == ToolbarSection::ToolbarInfo::ON ? ToolbarInfo::ON : ToolbarInfo::OFF);
279 if (info.state == ToolbarSection::ToolbarInfo::ON)
280 cit->flags = static_cast<lyx::ToolbarInfo::Flags>(flags);
287 void GuiToolbars::setLayout(docstring const & layout)
290 layout_->set(layout);
294 bool GuiToolbars::updateLayoutList(TextClassPtr textclass)
296 // update the layout display
297 if (last_textclass_ != textclass) {
299 layout_->updateContents();
300 last_textclass_ = textclass;
307 void GuiToolbars::openLayoutList()
310 layout_->showPopup();
314 void GuiToolbars::clearLayoutList()
316 last_textclass_ = TextClassPtr();
322 void GuiToolbars::add(ToolbarInfo const & tbinfo, bool newline)
324 GuiToolbar * tb_ptr = owner_.makeToolbar(tbinfo, newline);
325 toolbars_[tbinfo.name] = tb_ptr;
327 if (tbinfo.flags & ToolbarInfo::ON)
332 if (tb_ptr->layout())
333 layout_ = tb_ptr->layout();
337 void GuiToolbars::displayToolbar(ToolbarInfo const & tbinfo,
340 ToolbarsMap::iterator it = toolbars_.find(tbinfo.name);
341 BOOST_ASSERT(it != toolbars_.end());
344 if (it->second->isVisible())
348 else if (it->second->isVisible())
353 void GuiToolbars::updateIcons()
355 ToolbarsMap::const_iterator it = toolbars_.begin();
356 ToolbarsMap::const_iterator const end = toolbars_.end();
357 for (; it != end; ++it)
358 it->second->updateContents();
361 lyx::getStatus(FuncRequest(LFUN_LAYOUT)).enabled();
364 layout_->setEnabled(enable);
368 void GuiToolbars::showCommandBuffer(bool show_it)
370 ToolbarsMap::const_iterator it = toolbars_.begin();
371 ToolbarsMap::const_iterator const end = toolbars_.end();
372 for (; it != end; ++it) {
373 GuiCommandBuffer * cb = it->second->commandBuffer();
380 if (!it->second->isVisible())
387 } // namespace frontend