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"
23 #include "FuncRequest.h"
24 #include "FuncStatus.h"
28 #include "TextClass.h"
29 #include "ToolbarBackend.h"
31 #include "support/debug.h"
32 #include "support/gettext.h"
39 #define TurnOnFlag(x) flags |= ToolbarInfo::x
40 #define TurnOffFlag(x) flags &= ~ToolbarInfo::x
42 GuiToolbars::GuiToolbars(GuiView & owner)
49 void GuiToolbars::initFlags(ToolbarInfo & tbinfo)
51 ToolbarSection::ToolbarInfo & info = LyX::ref().session().toolbars().load(tbinfo.name);
53 unsigned int flags = static_cast<unsigned int>(tbinfo.flags);
55 // Remove default.ui positions. Only when a valid postion is stored
56 // in the session file the default.ui value will be overwritten
57 unsigned int save = flags;
63 bool valid_location = true;
64 // init tbinfo.flags with saved location
65 if (info.location == ToolbarSection::ToolbarInfo::TOP)
67 else if (info.location == ToolbarSection::ToolbarInfo::BOTTOM)
69 else if (info.location == ToolbarSection::ToolbarInfo::RIGHT)
71 else if (info.location == ToolbarSection::ToolbarInfo::LEFT)
74 // use setting from default.ui
76 valid_location = false;
79 // invalid location is for a new toolbar that has no saved information,
80 // so info.visible is not used for this case.
82 // init tbinfo.flags with saved visibility,
86 if (info.state == ToolbarSection::ToolbarInfo::ON)
88 else if (info.state == ToolbarSection::ToolbarInfo::OFF)
94 cout << "State " << info.state << " FLAGS: " << flags
95 << " ON:" << (flags & ToolbarBackend::ON)
96 << " OFF:" << (flags & ToolbarBackend::OFF)
97 << " L:" << (flags & ToolbarBackend::LEFT)
98 << " R:" << (flags & ToolbarBackend::RIGHT)
99 << " T:" << (flags & ToolbarBackend::TOP)
100 << " B:" << (flags & ToolbarBackend::BOTTOM)
101 << " MA:" << (flags & ToolbarBackend::MATH)
102 << " RE:" << (flags & ToolbarBackend::REVIEW)
103 << " TB:" << (flags & ToolbarBackend::TABLE)
104 << " AU:" << (flags & ToolbarBackend::AUTO)
108 tbinfo.flags = static_cast<lyx::ToolbarInfo::Flags>(flags);
112 void GuiToolbars::init()
114 ToolbarsMap::const_iterator it = toolbars_.begin();
115 for (; it != toolbars_.end(); ++it)
119 // extracts the toolbars from the backend
120 ToolbarBackend::Toolbars::iterator cit = toolbarbackend.begin();
121 ToolbarBackend::Toolbars::iterator end = toolbarbackend.end();
123 // init flags will also add these toolbars to session if they
124 // are not already there (e.g. first run of lyx).
125 for (; cit != end; ++cit)
128 // add toolbars according the order in session
129 ToolbarSection::ToolbarList::const_iterator tb =
130 LyX::ref().session().toolbars().begin();
131 ToolbarSection::ToolbarList::const_iterator te =
132 LyX::ref().session().toolbars().end();
133 ToolbarSection::ToolbarInfo::Location last_loc =
134 ToolbarSection::ToolbarInfo::NOTSET;
137 for (; tb != te; ++tb) {
138 LYXERR(Debug::INIT, "Adding " << tb->key << " at position "
139 << tb->info.posx << " " << tb->info.posy);
140 // add toolbar break if posx or posy changes
141 bool newline = tb->info.location == last_loc && (
142 // if two toolbars at the same location, assume uninitialized and add toolbar break
143 (tb->info.posx == last_posx && tb->info.posy == last_posy) ||
144 (last_loc == ToolbarSection::ToolbarInfo::TOP && tb->info.posy != last_posy) ||
145 (last_loc == ToolbarSection::ToolbarInfo::BOTTOM && tb->info.posy != last_posy) ||
146 (last_loc == ToolbarSection::ToolbarInfo::LEFT && tb->info.posx != last_posx) ||
147 (last_loc == ToolbarSection::ToolbarInfo::RIGHT && tb->info.posx != last_posx) );
148 // find the backend item and add
149 for (cit = toolbarbackend.begin(); cit != end; ++cit)
150 if (cit->name == tb->key) {
152 last_loc = tb->info.location;
153 last_posx = tb->info.posx;
154 last_posy = tb->info.posy;
161 void GuiToolbars::display(string const & name, bool show)
163 ToolbarBackend::Toolbars::iterator cit = toolbarbackend.begin();
164 ToolbarBackend::Toolbars::iterator end = toolbarbackend.end();
166 for (; cit != end; ++cit) {
167 if (cit->name == name) {
168 unsigned int flags = cit->flags;
176 cit->flags = static_cast<lyx::ToolbarInfo::Flags>(flags);
177 displayToolbar(*cit, show);
181 LYXERR(Debug::GUI, "Toolbar::display: no toolbar named " << name);
185 ToolbarInfo * GuiToolbars::getToolbarInfo(string const & name)
187 return toolbarbackend.getUsedToolbarInfo(name);
191 void GuiToolbars::toggleToolbarState(string const & name, bool allowauto)
193 ToolbarInfo * tbi = toolbarbackend.getUsedToolbarInfo(name);
196 LYXERR(Debug::GUI, "Toolbar::display: no toolbar named " << name);
200 int flags = tbi->flags;
202 if (flags & ToolbarInfo::OFF) {
206 } else if (flags & ToolbarInfo::AUTO) {
210 && ((flags & ToolbarInfo::MATH)
211 || (flags & ToolbarInfo::TABLE)
212 || (flags & ToolbarInfo::REVIEW)
213 || (flags & ToolbarInfo::MATHMACROTEMPLATE))) {
214 // for math etc, toggle from on -> auto
218 // for others, toggle from on -> off
222 tbi->flags = static_cast<ToolbarInfo::Flags>(flags);
228 void GuiToolbars::update(bool in_math, bool in_table, bool review,
229 bool in_mathmacrotemplate)
233 // extracts the toolbars from the backend
234 ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
235 ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
237 for (; cit != end; ++cit) {
238 if (cit->flags & ToolbarInfo::ON)
239 displayToolbar(*cit, true);
240 else if (cit->flags & ToolbarInfo::OFF)
241 displayToolbar(*cit, false);
242 else if ((cit->flags & ToolbarInfo::AUTO) && (cit->flags & ToolbarInfo::MATH))
243 displayToolbar(*cit, in_math);
244 else if ((cit->flags & ToolbarInfo::AUTO) && (cit->flags & ToolbarInfo::TABLE))
245 displayToolbar(*cit, in_table);
246 else if ((cit->flags & ToolbarInfo::AUTO) && (cit->flags & ToolbarInfo::REVIEW))
247 displayToolbar(*cit, review);
248 else if ((cit->flags & ToolbarInfo::AUTO) && (cit->flags & ToolbarInfo::MATHMACROTEMPLATE))
249 displayToolbar(*cit, in_mathmacrotemplate);
254 bool GuiToolbars::visible(string const & name) const
256 map<string, GuiToolbar *>::const_iterator it =
257 toolbars_.find(name);
258 if (it == toolbars_.end())
260 return it->second->isVisible();
264 void GuiToolbars::saveToolbarInfo()
266 ToolbarSection & tb = LyX::ref().session().toolbars();
268 for (ToolbarBackend::Toolbars::iterator cit = toolbarbackend.begin();
269 cit != toolbarbackend.end(); ++cit) {
270 ToolbarsMap::iterator it = toolbars_.find(cit->name);
271 BOOST_ASSERT(it != toolbars_.end());
272 // get toolbar info from session.
273 ToolbarSection::ToolbarInfo & info = tb.load(cit->name);
274 if (cit->flags & ToolbarInfo::ON)
275 info.state = ToolbarSection::ToolbarInfo::ON;
276 else if (cit->flags & ToolbarInfo::OFF)
277 info.state = ToolbarSection::ToolbarInfo::OFF;
278 else if (cit->flags & ToolbarInfo::AUTO)
279 info.state = ToolbarSection::ToolbarInfo::AUTO;
280 // save other information
281 // if auto, frontend should *not* set on/off
282 it->second->saveInfo(info);
283 // maybe it is useful to update flags with real status. I do not know
285 if (!(cit->flags & ToolbarInfo::AUTO)) {
286 unsigned int flags = static_cast<unsigned int>(cit->flags);
287 flags &= ~(info.state == ToolbarSection::ToolbarInfo::ON ? ToolbarInfo::OFF : ToolbarInfo::ON);
288 flags |= (info.state == ToolbarSection::ToolbarInfo::ON ? ToolbarInfo::ON : ToolbarInfo::OFF);
289 if (info.state == ToolbarSection::ToolbarInfo::ON)
290 cit->flags = static_cast<lyx::ToolbarInfo::Flags>(flags);
297 void GuiToolbars::add(ToolbarInfo const & tbinfo, bool newline)
299 GuiToolbar * tb_ptr = owner_.makeToolbar(tbinfo, newline);
300 toolbars_[tbinfo.name] = tb_ptr;
302 if (tbinfo.flags & ToolbarInfo::ON)
309 void GuiToolbars::displayToolbar(ToolbarInfo const & tbinfo,
312 ToolbarsMap::iterator it = toolbars_.find(tbinfo.name);
313 BOOST_ASSERT(it != toolbars_.end());
316 if (it->second->isVisible())
320 else if (it->second->isVisible())
325 void GuiToolbars::updateIcons()
327 ToolbarsMap::const_iterator it = toolbars_.begin();
328 ToolbarsMap::const_iterator const end = toolbars_.end();
329 for (; it != end; ++it)
330 it->second->updateContents();
334 void GuiToolbars::showCommandBuffer(bool show_it)
336 ToolbarsMap::const_iterator it = toolbars_.begin();
337 ToolbarsMap::const_iterator const end = toolbars_.end();
338 for (; it != end; ++it) {
339 GuiCommandBuffer * cb = it->second->commandBuffer();
343 // FIXME: this is a hack, "minibuffer" should not be
345 display("minibuffer", false);
348 if (!it->second->isVisible())
349 display("minibuffer", true);
355 } // namespace frontend