src/frontends/qt4/GuiToolbars.cpp

   1 /**
   2  * \file GuiToolbars.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author Lars Gullik Bjønnes
   7  * \author Angus Leeming
   8  * \author Abdelrazak Younes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #include <config.h>
  14
  15 #include "GuiToolbars.h"
  16
  17 #include "GuiCommandBuffer.h"
  18 #include "GuiToolbar.h"
  19 #include "GuiView.h"
  20
  21 #include "Buffer.h"
  22 #include "BufferParams.h"
  23 #include "debug.h"
  24 #include "FuncRequest.h"
  25 #include "FuncStatus.h"
  26 #include "gettext.h"
  27 #include "Layout.h"
  28 #include "LyX.h"
  29 #include "LyXFunc.h"
  30 #include "TextClass.h"
  31 #include "ToolbarBackend.h"
  32
  33
  34 using std::endl;
  35 using std::string;
  36
  37 namespace lyx {
  38 namespace frontend {
  39
  40 #define TurnOnFlag(x)   flags |= ToolbarInfo::x
  41 #define TurnOffFlag(x)  flags &= ~ToolbarInfo::x
  42
  43 GuiToolbars::GuiToolbars(GuiView & owner)
  44         : owner_(owner)
  45 {
  46         init();
  47 }
  48
  49
  50 void GuiToolbars::initFlags(ToolbarInfo & tbinfo)
  51 {
  52         ToolbarSection::ToolbarInfo & info = LyX::ref().session().toolbars().load(tbinfo.name);
  53
  54         unsigned int flags = static_cast<unsigned int>(tbinfo.flags);
  55
  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;
  59         TurnOffFlag(TOP);
  60         TurnOffFlag(BOTTOM);
  61         TurnOffFlag(RIGHT);
  62         TurnOffFlag(LEFT);
  63
  64         bool valid_location = true;
  65         // init tbinfo.flags with saved location
  66         if (info.location == ToolbarSection::ToolbarInfo::TOP)
  67                 TurnOnFlag(TOP);
  68         else if (info.location == ToolbarSection::ToolbarInfo::BOTTOM)
  69                 TurnOnFlag(BOTTOM);
  70         else if (info.location == ToolbarSection::ToolbarInfo::RIGHT)
  71                 TurnOnFlag(RIGHT);
  72         else if (info.location == ToolbarSection::ToolbarInfo::LEFT)
  73                 TurnOnFlag(LEFT);
  74         else {
  75                 // use setting from default.ui
  76                 flags = save;
  77                 valid_location = false;
  78         }
  79
  80         // invalid location is for a new toolbar that has no saved information,
  81         // so info.visible is not used for this case.
  82         if (valid_location) {
  83                 // init tbinfo.flags with saved visibility,
  84                 TurnOffFlag(ON);
  85                 TurnOffFlag(OFF);
  86                 TurnOffFlag(AUTO);
  87                 if (info.state == ToolbarSection::ToolbarInfo::ON)
  88                         TurnOnFlag(ON);
  89                 else if (info.state == ToolbarSection::ToolbarInfo::OFF)
  90                         TurnOnFlag(OFF);
  91                 else
  92                         TurnOnFlag(AUTO);
  93         }
  94         /*
  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)
 106                 << std::endl;
 107         */
 108         // now set the flags
 109         tbinfo.flags = static_cast<lyx::ToolbarInfo::Flags>(flags);
 110 }
 111
 112
 113 void GuiToolbars::init()
 114 {
 115         ToolbarsMap::const_iterator it = toolbars_.begin();
 116         for (; it != toolbars_.end(); ++it)
 117                 delete it->second;
 118         toolbars_.clear();
 119
 120         // extracts the toolbars from the backend
 121         ToolbarBackend::Toolbars::iterator cit = toolbarbackend.begin();
 122         ToolbarBackend::Toolbars::iterator end = toolbarbackend.end();
 123
 124         // init flags will also add these toolbars to session if they
 125         // are not already there (e.g. first run of lyx).
 126         for (; cit != end; ++cit)
 127                 initFlags(*cit);
 128
 129         // add toolbars according the order in session
 130         ToolbarSection::ToolbarList::const_iterator tb =
 131                 LyX::ref().session().toolbars().begin();
 132         ToolbarSection::ToolbarList::const_iterator te =
 133                 LyX::ref().session().toolbars().end();
 134         ToolbarSection::ToolbarInfo::Location last_loc =
 135                 ToolbarSection::ToolbarInfo::NOTSET;
 136         int last_posx = 0;
 137         int last_posy = 0;
 138         for (; tb != te; ++tb) {
 139                 LYXERR(Debug::INIT, "Adding " << tb->key << " at position "
 140                         << tb->info.posx << " " << tb->info.posy);
 141                 // add toolbar break if posx or posy changes
 142                 bool newline = tb->info.location == last_loc && (
 143                         // if two toolbars at the same location, assume uninitialized and add toolbar break
 144                         (tb->info.posx == last_posx && tb->info.posy == last_posy) ||
 145                         (last_loc == ToolbarSection::ToolbarInfo::TOP && tb->info.posy != last_posy) ||
 146                         (last_loc == ToolbarSection::ToolbarInfo::BOTTOM && tb->info.posy != last_posy) ||
 147                         (last_loc == ToolbarSection::ToolbarInfo::LEFT && tb->info.posx != last_posx) ||
 148                         (last_loc == ToolbarSection::ToolbarInfo::RIGHT && tb->info.posx != last_posx) );
 149                 // find the backend item and add
 150                 for (cit = toolbarbackend.begin(); cit != end; ++cit)
 151                         if (cit->name == tb->key) {
 152                                 add(*cit, newline);
 153                                 last_loc = tb->info.location;
 154                                 last_posx = tb->info.posx;
 155                                 last_posy = tb->info.posy;
 156                                 break;
 157                         }
 158         }
 159 }
 160
 161
 162 void GuiToolbars::display(string const & name, bool show)
 163 {
 164         ToolbarBackend::Toolbars::iterator cit = toolbarbackend.begin();
 165         ToolbarBackend::Toolbars::iterator end = toolbarbackend.end();
 166
 167         for (; cit != end; ++cit) {
 168                 if (cit->name == name) {
 169                         unsigned int flags = cit->flags;
 170                         TurnOffFlag(ON);
 171                         TurnOffFlag(OFF);
 172                         TurnOffFlag(AUTO);
 173                         if (show)
 174                                 TurnOnFlag(ON);
 175                         else
 176                                 TurnOnFlag(OFF);
 177                         cit->flags = static_cast<lyx::ToolbarInfo::Flags>(flags);
 178                         displayToolbar(*cit, show);
 179                 }
 180         }
 181
 182         LYXERR(Debug::GUI, "Toolbar::display: no toolbar named " << name);
 183 }
 184
 185
 186 ToolbarInfo * GuiToolbars::getToolbarInfo(string const & name)
 187 {
 188         return toolbarbackend.getUsedToolbarInfo(name);
 189 }
 190
 191
 192 void GuiToolbars::toggleToolbarState(string const & name, bool allowauto)
 193 {
 194         ToolbarInfo * tbi = toolbarbackend.getUsedToolbarInfo(name);
 195
 196         if (!tbi) {
 197                 LYXERR(Debug::GUI, "Toolbar::display: no toolbar named " << name);
 198                 return;
 199         }
 200
 201         int flags = tbi->flags;
 202         // off -> on
 203         if (flags & ToolbarInfo::OFF) {
 204                 TurnOffFlag(OFF);
 205                 TurnOnFlag(ON);
 206         // auto -> off
 207         } else if (flags & ToolbarInfo::AUTO) {
 208                 TurnOffFlag(AUTO);
 209                 TurnOnFlag(OFF);
 210         } else if (allowauto
 211                    && ((flags & ToolbarInfo::MATH)
 212                        || (flags & ToolbarInfo::TABLE)
 213                        || (flags & ToolbarInfo::REVIEW))) {
 214                 // for math etc, toggle from on -> auto
 215                 TurnOffFlag(ON);
 216                 TurnOnFlag(AUTO);
 217         } else {
 218                 // for others, toggle from on -> off
 219                 TurnOffFlag(ON);
 220                 TurnOnFlag(OFF);
 221         }
 222         tbi->flags = static_cast<ToolbarInfo::Flags>(flags);
 223 }
 224 #undef TurnOnFlag
 225 #undef TurnOffFlag
 226
 227
 228 void GuiToolbars::update(bool in_math, bool in_table, bool review)
 229 {
 230         updateIcons();
 231
 232         // extracts the toolbars from the backend
 233         ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
 234         ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
 235
 236         for (; cit != end; ++cit) {
 237                 if (cit->flags & ToolbarInfo::ON)
 238                         displayToolbar(*cit, true);
 239                 else if (cit->flags & ToolbarInfo::OFF)
 240                         displayToolbar(*cit, false);
 241                 else if ((cit->flags & ToolbarInfo::AUTO) && (cit->flags & ToolbarInfo::MATH))
 242                         displayToolbar(*cit, in_math);
 243                 else if ((cit->flags & ToolbarInfo::AUTO) && (cit->flags & ToolbarInfo::TABLE))
 244                         displayToolbar(*cit, in_table);
 245                 else if ((cit->flags & ToolbarInfo::AUTO) && (cit->flags & ToolbarInfo::REVIEW))
 246                         displayToolbar(*cit, review);
 247         }
 248 }
 249
 250
 251 bool GuiToolbars::visible(string const & name) const
 252 {
 253         std::map<string, GuiToolbar *>::const_iterator it =
 254                 toolbars_.find(name);
 255         if (it == toolbars_.end())
 256                 return false;
 257         return it->second->isVisible();
 258 }
 259
 260
 261 void GuiToolbars::saveToolbarInfo()
 262 {
 263         ToolbarSection & tb = LyX::ref().session().toolbars();
 264
 265         for (ToolbarBackend::Toolbars::iterator cit = toolbarbackend.begin();
 266                 cit != toolbarbackend.end(); ++cit) {
 267                 ToolbarsMap::iterator it = toolbars_.find(cit->name);
 268                 BOOST_ASSERT(it != toolbars_.end());
 269                 // get toolbar info from session.
 270                 ToolbarSection::ToolbarInfo & info = tb.load(cit->name);
 271                 if (cit->flags & ToolbarInfo::ON)
 272                         info.state = ToolbarSection::ToolbarInfo::ON;
 273                 else if (cit->flags & ToolbarInfo::OFF)
 274                         info.state = ToolbarSection::ToolbarInfo::OFF;
 275                 else if (cit->flags & ToolbarInfo::AUTO)
 276                         info.state = ToolbarSection::ToolbarInfo::AUTO;
 277                 // save other information
 278                 // if auto, frontend should *not* set on/off
 279                 it->second->saveInfo(info);
 280                 // maybe it is useful to update flags with real status. I do not know
 281                 /*
 282                 if (!(cit->flags & ToolbarInfo::AUTO)) {
 283                         unsigned int flags = static_cast<unsigned int>(cit->flags);
 284                         flags &= ~(info.state == ToolbarSection::ToolbarInfo::ON ? ToolbarInfo::OFF : ToolbarInfo::ON);
 285                         flags |= (info.state == ToolbarSection::ToolbarInfo::ON ? ToolbarInfo::ON : ToolbarInfo::OFF);
 286                         if (info.state == ToolbarSection::ToolbarInfo::ON)
 287                         cit->flags = static_cast<lyx::ToolbarInfo::Flags>(flags);
 288                 }
 289                 */
 290         }
 291 }
 292
 293
 294 void GuiToolbars::add(ToolbarInfo const & tbinfo, bool newline)
 295 {
 296         GuiToolbar * tb_ptr = owner_.makeToolbar(tbinfo, newline);
 297         toolbars_[tbinfo.name] = tb_ptr;
 298
 299         if (tbinfo.flags & ToolbarInfo::ON)
 300                 tb_ptr->show();
 301         else
 302                 tb_ptr->hide();
 303 }
 304
 305
 306 void GuiToolbars::displayToolbar(ToolbarInfo const & tbinfo,
 307                               bool show_it)
 308 {
 309         ToolbarsMap::iterator it = toolbars_.find(tbinfo.name);
 310         BOOST_ASSERT(it != toolbars_.end());
 311
 312         if (show_it) {
 313                 if (it->second->isVisible())
 314                         return;
 315                 it->second->show();
 316         }
 317         else if (it->second->isVisible())
 318                 it->second->hide();
 319 }
 320
 321
 322 void GuiToolbars::updateIcons()
 323 {
 324         ToolbarsMap::const_iterator it = toolbars_.begin();
 325         ToolbarsMap::const_iterator const end = toolbars_.end();
 326         for (; it != end; ++it)
 327                 it->second->updateContents();
 328 }
 329
 330
 331 void GuiToolbars::showCommandBuffer(bool show_it)
 332 {
 333         ToolbarsMap::const_iterator it = toolbars_.begin();
 334         ToolbarsMap::const_iterator const end = toolbars_.end();
 335         for (; it != end; ++it) {
 336                 GuiCommandBuffer * cb = it->second->commandBuffer();
 337                 if (!cb)
 338                         continue;
 339                 if (!show_it) {
 340                         // FIXME: this is a hack, "minibuffer" should not be
 341                         // hardcoded.
 342                         display("minibuffer", false);
 343                         return;
 344                 }
 345                 if (!it->second->isVisible())
 346                         display("minibuffer", true);
 347                 cb->setFocus();
 348                 return;
 349         }
 350 }
 351
 352 } // namespace frontend
 353 } // namespace lyx