src/frontends/qt4/GuiMenubar.cpp

   1 /**
   2  * \file qt4/GuiMenubar.cpp
   3  * This file is part of LyX, the document processor.
   4  * Licence details can be found in the file COPYING.
   5  *
   6  * \author John Levon
   7  *
   8  * Full author contact details are available in file CREDITS.
   9  */
  10
  11 #include <config.h>
  12
  13 // Qt defines a macro 'signals' that clashes with a boost namespace.
  14 // All is well if the namespace is visible first.
  15 #include "GuiView.h"
  16
  17 #include "Action.h"
  18 #include "GuiMenubar.h"
  19 #include "GuiPopupMenu.h"
  20
  21 #include "qt_helpers.h"
  22 #include "support/lstrings.h"
  23
  24 #include "MenuBackend.h"
  25
  26 #include "debug.h"
  27
  28 #include <QCursor>
  29 #include <QMenuBar>
  30
  31 using std::pair;
  32 using std::string;
  33 using std::endl;
  34
  35 namespace lyx {
  36 namespace frontend {
  37
  38 // MacOSX specific stuff is at the end.
  39
  40 GuiMenubar::GuiMenubar(LyXView * view, MenuBackend & mbe)
  41         : owner_(static_cast<GuiViewBase*>(view)), menubackend_(mbe)
  42 {
  43         macxMenuBarInit();
  44
  45         LYXERR(Debug::GUI) << "populating menu bar" << to_utf8(menubackend_.getMenubar().name()) << endl;
  46
  47         if (menubackend_.getMenubar().size() == 0) {
  48                 LYXERR(Debug::GUI) << "\tERROR: empty menu bar"
  49                         << to_utf8(menubackend_.getMenubar().name()) << endl;
  50                 return;
  51                 //                      continue;
  52         }
  53         else {
  54                 LYXERR(Debug::GUI) << "menu bar entries "
  55                         << menubackend_.getMenubar().size();
  56         }
  57
  58         Menu menu;
  59         menubackend_.expand(menubackend_.getMenubar(), menu, owner_->buffer());
  60
  61         Menu::const_iterator m = menu.begin();
  62         Menu::const_iterator end = menu.end();
  63
  64         for (; m != end; ++m) {
  65
  66                 if (m->kind() != MenuItem::Submenu) {
  67                         LYXERR(Debug::GUI) << "\tERROR: not a submenu "
  68                                 << to_utf8(m->label()) << endl;
  69                         continue;
  70                 }
  71
  72                 LYXERR(Debug::GUI) << "menu bar item " << to_utf8(m->label())
  73                         << " is a submenu named " << to_utf8(m->submenuname()) << endl;
  74
  75                 docstring name = m->submenuname();
  76                 if (!menubackend_.hasMenu(name)) {
  77                         LYXERR(Debug::GUI) << "\tERROR: " << to_utf8(name)
  78                                 << " submenu has no menu!" << endl;
  79                         continue;
  80                 }
  81
  82                 Menu menu;
  83                 menubackend_.expand(menubackend_.getMenubar(), menu, owner_->buffer());
  84
  85                 GuiPopupMenu * qMenu = new GuiPopupMenu(this, *m, true);
  86                 owner_->menuBar()->addMenu(qMenu);
  87
  88                 name_map_[toqstr(name)] = qMenu;
  89 /*
  90                 QObject::connect(qMenu, SIGNAL(aboutToShow()), this, SLOT(update()));
  91                 QObject::connect(qMenu, SIGNAL(triggered(QAction *)), this, SLOT(update()));
  92                 QObject::connect(qMenu->menuAction(), SIGNAL(triggered()), this, SLOT(update()));
  93 */
  94         }
  95         //QObject::connect(owner_->menuBar(), SIGNAL(triggered()), this, SLOT(update()));
  96 }
  97
  98
  99 void GuiMenubar::openByName(QString const & name)
 100 {
 101         if (QMenu * menu = name_map_.value(name))
 102                 menu->exec(QCursor::pos());
 103 }
 104
 105
 106 /// Some special Qt/Mac support hacks
 107
 108 /*
 109   Here is what the Qt documentation says about how a menubar is chosen:
 110
 111      1) If the window has a QMenuBar then it is used. 2) If the window
 112      is a modal then its menubar is used. If no menubar is specified
 113      then a default menubar is used (as documented below) 3) If the
 114      window has no parent then the default menubar is used (as
 115      documented below).
 116
 117      The above 3 steps are applied all the way up the parent window
 118      chain until one of the above are satisifed. If all else fails a
 119      default menubar will be created, the default menubar on Qt/Mac is
 120      an empty menubar, however you can create a different default
 121      menubar by creating a parentless QMenuBar, the first one created
 122      will thus be designated the default menubar, and will be used
 123      whenever a default menubar is needed.
 124
 125   Thus, for Qt/Mac, we add the menus to a free standing menubar, so
 126   that this menubar will be used also when one of LyX' dialogs has
 127   focus. (JMarc)
 128 */
 129 QMenuBar * GuiMenubar::menuBar() const
 130 {
 131 #ifdef Q_WS_MACX
 132         return mac_menubar_;
 133 #else
 134         return owner_->menuBar();
 135 #endif
 136 }
 137
 138 #ifdef Q_WS_MACX
 139 extern void qt_mac_set_menubar_merge(bool b);
 140 #endif
 141
 142 void GuiMenubar::macxMenuBarInit()
 143 {
 144 #ifdef Q_WS_MACX
 145         mac_menubar_.reset(new QMenuBar);
 146
 147 # if QT_VERSION >= 0x040200
 148         /* Since Qt 4.2, the qt/mac menu code has special code for
 149            specifying the role of a menu entry. However, it does not
 150            work very well with our scheme of creating menus on demand,
 151            and therefore we need to put these entries in a special
 152            invisible menu. (JMarc)
 153         */
 154
 155         /* The entries of our special mac menu. If we add support for
 156          * special entries in MenuBackend, we could imagine something
 157          * like
 158          *    SpecialItem About " "About LyX" "dialog-show aboutlyx"
 159          * and therefore avoid hardcoding. I am not sure it is worth
 160          * the hassle, though. (JMarc)
 161          */
 162         struct MacMenuEntry {
 163                 kb_action action;
 164                 char const * arg;
 165                 char const * label;
 166                 QAction::MenuRole role;
 167         };
 168
 169         MacMenuEntry entries[] = {
 170                 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
 171                  QAction::AboutRole},
 172                 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
 173                  QAction::PreferencesRole},
 174                 {LFUN_RECONFIGURE, "", "Reconfigure",
 175                  QAction::ApplicationSpecificRole},
 176                 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
 177         };
 178         const size_t num_entries = sizeof(entries) / sizeof(MacMenuEntry);
 179
 180         // the special menu for MenuBackend.
 181         Menu special;
 182         for (size_t i = 0 ; i < num_entries ; ++i) {
 183                 FuncRequest const func(entries[i].action,
 184                                        from_utf8(entries[i].arg));
 185                 special.add(MenuItem(MenuItem::Command,
 186                                      from_utf8(entries[i].label),
 187                                      func));
 188         }
 189         menubackend_.specialMenu(special);
 190
 191         // add the entries to a QMenu that will eventually be empty
 192         // and therefore invisible.
 193         QMenu * qMenu = owner_->menuBar()->addMenu("special");
 194
 195         // we do not use 'special' because it is a temporary variable,
 196         // whereas MenuBackend::specialMenu points to a persistent
 197         // copy.
 198         Menu::const_iterator cit = menubackend_.specialMenu().begin();
 199         Menu::const_iterator end = menubackend_.specialMenu().end();
 200         for (size_t i = 0 ; cit != end ; ++cit, ++i) {
 201                 Action * action = new Action(*owner_, cit->label(),
 202                                              cit->func());
 203                 action->setMenuRole(entries[i].role);
 204                 qMenu->addAction(action);
 205
 206         }
 207 # else
 208         qt_mac_set_menubar_merge(false);
 209 # endif // QT_VERSION >= 0x040200
 210 #endif // Q_WS_MACX
 211 }
 212
 213 } // namespace frontend
 214 } // namespace lyx
 215
 216 #include "GuiMenubar_moc.cpp"