src/frontends/qt4/Menus.cpp

   1 /**
   2  * \file qt4/Menus.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  * \author Asger Alstrup
   8  * \author Lars Gullik Bjønnes
   9  * \author Jean-Marc Lasgouttes
  10  * \author André Pönitz
  11  * \author Dekel Tsur
  12  * \author Martin Vermeer
  13  *
  14  * Full author contact details are available in file CREDITS.
  15  */
  16
  17 #include <config.h>
  18
  19 #include "Menus.h"
  20
  21 #include "Action.h"
  22 #include "GuiApplication.h"
  23 #include "GuiView.h"
  24 #include "GuiWorkArea.h"
  25 #include "qt_helpers.h"
  26
  27 #include "BiblioInfo.h"
  28 #include "BranchList.h"
  29 #include "Buffer.h"
  30 #include "BufferList.h"
  31 #include "BufferParams.h"
  32 #include "BufferView.h"
  33 #include "Converter.h"
  34 #include "CutAndPaste.h"
  35 #include "Floating.h"
  36 #include "FloatList.h"
  37 #include "Format.h"
  38 #include "FuncRequest.h"
  39 #include "FuncStatus.h"
  40 #include "IndicesList.h"
  41 #include "KeyMap.h"
  42 #include "Language.h"
  43 #include "Lexer.h"
  44 #include "LyXAction.h"
  45 #include "LyX.h"
  46 #include "LyXRC.h"
  47 #include "lyxfind.h"
  48 #include "Paragraph.h"
  49 #include "ParIterator.h"
  50 #include "Session.h"
  51 #include "SpellChecker.h"
  52 #include "TextClass.h"
  53 #include "TocBackend.h"
  54 #include "Toolbars.h"
  55 #include "WordLangTuple.h"
  56
  57 #include "insets/Inset.h"
  58 #include "insets/InsetCitation.h"
  59 #include "insets/InsetGraphics.h"
  60
  61 #include "support/lassert.h"
  62 #include "support/convert.h"
  63 #include "support/debug.h"
  64 #include "support/docstring_list.h"
  65 #include "support/filetools.h"
  66 #include "support/gettext.h"
  67 #include "support/lstrings.h"
  68
  69 #include <QCursor>
  70 #include <QHash>
  71 #include <QList>
  72 #include <QMenuBar>
  73 #include <QString>
  74 #if QT_VERSION >= 0x040600
  75 #include <QProxyStyle>
  76 #endif
  77
  78 #include "support/shared_ptr.h"
  79
  80 #include <algorithm>
  81 #include <vector>
  82
  83 using namespace std;
  84 using namespace lyx::support;
  85
  86
  87 namespace lyx {
  88 namespace frontend {
  89
  90 namespace {
  91
  92 // MacOSX specific stuff is at the end.
  93
  94 class MenuDefinition;
  95
  96 ///
  97 class MenuItem {
  98 public:
  99         /// The type of elements that can be in a menu
 100         enum Kind {
 101                 ///
 102                 Command,
 103                 ///
 104                 Submenu,
 105                 ///
 106                 Separator,
 107                 /** This type of item explains why something is unavailable. If this
 108                     menuitem is in a submenu, the submenu is enabled to make sure the
 109                     user sees the information. */
 110                 Help,
 111                 /** This type of item merely shows that there might be a list or
 112                     something alike at this position, but the list is still empty.
 113                     If this item is in a submenu, the submenu will not always be
 114                     enabled. */
 115                 Info,
 116                 /** This is the list of last opened file,
 117                     typically for the File menu. */
 118                 Lastfiles,
 119                 /** This is the list of opened Documents,
 120                     typically for the Documents menu. */
 121                 Documents,
 122                 /** This is the bookmarks */
 123                 Bookmarks,
 124                 ///
 125                 Toc,
 126                 /** This is a list of viewable formats
 127                     typically for the File->View menu. */
 128                 ViewFormats,
 129                 /** This is a list of updatable formats
 130                     typically for the File->Update menu. */
 131                 UpdateFormats,
 132                 /** This is a list of exportable formats
 133                     typically for the File->Export menu. */
 134                 ExportFormats,
 135                 /** This is a list of importable formats
 136                     typically for the File->Import menu. */
 137                 ImportFormats,
 138                 /** This is the list of elements available
 139                  * for insertion into document. */
 140                 CharStyles,
 141                 /** This is the list of user-configurable
 142                 insets to insert into document */
 143                 Custom,
 144                 /** This is the list of XML elements to
 145                 insert into the document */
 146                 Elements,
 147                 /** This is the list of floats that we can
 148                     insert a list for. */
 149                 FloatListInsert,
 150                 /** This is the list of floats that we can
 151                     insert. */
 152                 FloatInsert,
 153                 /** This is the list of selections that can
 154                     be pasted. */
 155                 PasteRecent,
 156                 /** toolbars */
 157                 Toolbars,
 158                 /** Available branches in document */
 159                 Branches,
 160                 /** Available indices in document */
 161                 Indices,
 162                 /** Context menu for indices in document */
 163                 IndicesContext,
 164                 /** Available index lists in document */
 165                 IndicesLists,
 166                 /** Context menu for available indices lists in document */
 167                 IndicesListsContext,
 168                 /** Available citation styles for a given citation */
 169                 CiteStyles,
 170                 /** Available graphics groups */
 171                 GraphicsGroups,
 172                 /// Words suggested by the spellchecker.
 173                 SpellingSuggestions,
 174                 /** Used Languages */
 175                 LanguageSelector
 176         };
 177
 178         explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
 179
 180         MenuItem(Kind kind,
 181                  QString const & label,
 182                  QString const & submenu = QString(),
 183                  QString const & tooltip = QString(),
 184                  bool optional = false)
 185                 : kind_(kind), label_(label), submenuname_(submenu),
 186                   tooltip_(tooltip), optional_(optional)
 187         {
 188                 LASSERT(kind == Submenu || kind == Help || kind == Info, /**/);
 189         }
 190
 191         MenuItem(Kind kind,
 192                  QString const & label,
 193                  FuncRequest const & func,
 194                  QString const & tooltip = QString(),
 195                  bool optional = false,
 196                  FuncRequest::Origin origin = FuncRequest::MENU)
 197                 : kind_(kind), label_(label), func_(func),
 198                   tooltip_(tooltip), optional_(optional)
 199         {
 200                 func_.setOrigin(origin);
 201         }
 202
 203         // shared_ptr<MenuDefinition> needs this apprently...
 204         ~MenuItem() {}
 205
 206         /// The label of a given menuitem
 207         QString label() const
 208         {
 209                 int const index = label_.lastIndexOf('|');
 210                 return index == -1 ? label_ : label_.left(index);
 211         }
 212
 213         /// The keyboard shortcut (usually underlined in the entry)
 214         QString shortcut() const
 215         {
 216                 int const index = label_.lastIndexOf('|');
 217                 return index == -1 ? QString() : label_.mid(index + 1);
 218         }
 219         /// The complete label, with label and shortcut separated by a '|'
 220         QString fulllabel() const { return label_; }
 221         /// The kind of entry
 222         Kind kind() const { return kind_; }
 223         /// the action (if relevant)
 224         FuncRequest const & func() const { return func_; }
 225         /// the tooltip
 226         QString const & tooltip() const { return tooltip_; }
 227         /// returns true if the entry should be omitted when disabled
 228         bool optional() const { return optional_; }
 229         /// returns the status of the lfun associated with this entry
 230         FuncStatus const & status() const { return status_; }
 231         /// returns the status of the lfun associated with this entry
 232         FuncStatus & status() { return status_; }
 233         /// returns the status of the lfun associated with this entry
 234         void status(FuncStatus const & status) { status_ = status; }
 235
 236         ///returns the binding associated to this action.
 237         QString binding() const
 238         {
 239                 if (kind_ != Command)
 240                         return QString();
 241                 // Get the keys bound to this action, but keep only the
 242                 // first one later
 243                 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
 244                 if (bindings.size())
 245                         return toqstr(bindings.begin()->print(KeySequence::ForGui));
 246
 247                 LYXERR(Debug::KBMAP, "No binding for "
 248                         << lyxaction.getActionName(func_.action())
 249                         << '(' << func_.argument() << ')');
 250                 return QString();
 251         }
 252
 253         /// the description of the  submenu (if relevant)
 254         QString const & submenuname() const { return submenuname_; }
 255         /// set the description of the  submenu
 256         void submenuname(QString const & name) { submenuname_ = name; }
 257         ///
 258         bool hasSubmenu() const { return !submenu_.isEmpty(); }
 259         ///
 260         MenuDefinition const & submenu() const { return submenu_.at(0); }
 261         MenuDefinition & submenu() { return submenu_[0]; }
 262         ///
 263         void setSubmenu(MenuDefinition const & menu)
 264         {
 265                 submenu_.clear();
 266                 submenu_.append(menu);
 267         }
 268
 269 private:
 270         ///
 271         Kind kind_;
 272         ///
 273         QString label_;
 274         ///
 275         FuncRequest func_;
 276         ///
 277         QString submenuname_;
 278         ///
 279         QString tooltip_;
 280         ///
 281         bool optional_;
 282         ///
 283         FuncStatus status_;
 284         /// contains 0 or 1 item.
 285         QList<MenuDefinition> submenu_;
 286 };
 287
 288 ///
 289 class MenuDefinition {
 290 public:
 291         ///
 292         typedef std::vector<MenuItem> ItemList;
 293         ///
 294         typedef ItemList::const_iterator const_iterator;
 295         ///
 296         explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
 297
 298         ///
 299         void read(Lexer &);
 300         ///
 301         QString const & name() const { return name_; }
 302         ///
 303         bool empty() const { return items_.empty(); }
 304         /// Clear the menu content.
 305         void clear() { items_.clear(); }
 306         ///
 307         size_t size() const { return items_.size(); }
 308         ///
 309         MenuItem const & operator[](size_t) const;
 310         ///
 311         const_iterator begin() const { return items_.begin(); }
 312         ///
 313         const_iterator end() const { return items_.end(); }
 314         ///
 315         void cat(MenuDefinition const & other);
 316         ///
 317         void catSub(docstring const & name);
 318
 319         // search for func in this menu iteratively, and put menu
 320         // names in a stack.
 321         bool searchMenu(FuncRequest const & func, docstring_list & names)
 322                 const;
 323         ///
 324         bool hasFunc(FuncRequest const &) const;
 325         /// Add the menu item unconditionally
 326         void add(MenuItem const & item) { items_.push_back(item); }
 327         /// Checks the associated FuncRequest status before adding the
 328         /// menu item.
 329         void addWithStatusCheck(MenuItem const &);
 330         // Check whether the menu shortcuts are unique
 331         void checkShortcuts() const;
 332         ///
 333         void expandLastfiles();
 334         void expandDocuments();
 335         void expandBookmarks();
 336         void expandFormats(MenuItem::Kind kind, Buffer const * buf);
 337         void expandFloatListInsert(Buffer const * buf);
 338         void expandFloatInsert(Buffer const * buf);
 339         void expandFlexInsert(Buffer const * buf, InsetLayout::InsetLyXType type);
 340         void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth);
 341         void expandToc(Buffer const * buf);
 342         void expandPasteRecent(Buffer const * buf);
 343         void expandToolbars();
 344         void expandBranches(Buffer const * buf);
 345         void expandIndices(Buffer const * buf, bool listof = false);
 346         void expandIndicesContext(Buffer const * buf, bool listof = false);
 347         void expandCiteStyles(BufferView const *);
 348         void expandGraphicsGroups(BufferView const *);
 349         void expandSpellingSuggestions(BufferView const *);
 350         void expandLanguageSelector(Buffer const * buf);
 351         ///
 352         ItemList items_;
 353         ///
 354         QString name_;
 355 };
 356
 357
 358 /// Helper for std::find_if
 359 class MenuNamesEqual
 360 {
 361 public:
 362         MenuNamesEqual(QString const & name) : name_(name) {}
 363         bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
 364 private:
 365         QString name_;
 366 };
 367
 368
 369 ///
 370 typedef std::vector<MenuDefinition> MenuList;
 371 ///
 372 typedef MenuList::const_iterator const_iterator;
 373 ///
 374 typedef MenuList::iterator iterator;
 375
 376 /////////////////////////////////////////////////////////////////////
 377 // MenuDefinition implementation
 378 /////////////////////////////////////////////////////////////////////
 379
 380 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
 381 {
 382         switch (i.kind()) {
 383
 384         case MenuItem::Command: {
 385                 FuncStatus status = lyx::getStatus(i.func());
 386                 if (status.unknown() || (!status.enabled() && i.optional()))
 387                         break;
 388                 items_.push_back(i);
 389                 items_.back().status(status);
 390                 break;
 391         }
 392
 393         case MenuItem::Submenu: {
 394                 bool enabled = false;
 395                 if (i.hasSubmenu()) {
 396                         for (const_iterator cit = i.submenu().begin();
 397                                   cit != i.submenu().end(); ++cit) {
 398                                 // Only these kind of items affect the status of the submenu
 399                                 if ((cit->kind() == MenuItem::Command
 400                                         || cit->kind() == MenuItem::Submenu
 401                                         || cit->kind() == MenuItem::Help)
 402                                     && cit->status().enabled()) {
 403                                         enabled = true;
 404                                         break;
 405                                 }
 406                         }
 407                 }
 408                 if (enabled || !i.optional()) {
 409                         items_.push_back(i);
 410                         items_.back().status().setEnabled(enabled);
 411                 }
 412                 break;
 413         }
 414
 415         case MenuItem::Separator:
 416                 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
 417                         items_.push_back(i);
 418                 break;
 419
 420         default:
 421                 items_.push_back(i);
 422         }
 423 }
 424
 425
 426 void MenuDefinition::read(Lexer & lex)
 427 {
 428         enum {
 429                 md_item = 1,
 430                 md_branches,
 431                 md_citestyles,
 432                 md_documents,
 433                 md_bookmarks,
 434                 md_charstyles,
 435                 md_custom,
 436                 md_elements,
 437                 md_endmenu,
 438                 md_exportformats,
 439                 md_importformats,
 440                 md_indices,
 441                 md_indicescontext,
 442                 md_indiceslists,
 443                 md_indiceslistscontext,
 444                 md_lastfiles,
 445                 md_optitem,
 446                 md_optsubmenu,
 447                 md_separator,
 448                 md_submenu,
 449                 md_toc,
 450                 md_updateformats,
 451                 md_viewformats,
 452                 md_floatlistinsert,
 453                 md_floatinsert,
 454                 md_pasterecent,
 455                 md_toolbars,
 456                 md_graphicsgroups,
 457                 md_spellingsuggestions,
 458                 md_languageselector
 459         };
 460
 461         LexerKeyword menutags[] = {
 462                 { "bookmarks", md_bookmarks },
 463                 { "branches", md_branches },
 464                 { "charstyles", md_charstyles },
 465                 { "citestyles", md_citestyles },
 466                 { "custom", md_custom },
 467                 { "documents", md_documents },
 468                 { "elements", md_elements },
 469                 { "end", md_endmenu },
 470                 { "exportformats", md_exportformats },
 471                 { "floatinsert", md_floatinsert },
 472                 { "floatlistinsert", md_floatlistinsert },
 473                 { "graphicsgroups", md_graphicsgroups },
 474                 { "importformats", md_importformats },
 475                 { "indices", md_indices },
 476                 { "indicescontext", md_indicescontext },
 477                 { "indiceslists", md_indiceslists },
 478                 { "indiceslistscontext", md_indiceslistscontext },
 479                 { "item", md_item },
 480                 { "languageselector", md_languageselector },
 481                 { "lastfiles", md_lastfiles },
 482                 { "optitem", md_optitem },
 483                 { "optsubmenu", md_optsubmenu },
 484                 { "pasterecent", md_pasterecent },
 485                 { "separator", md_separator },
 486                 { "spellingsuggestions", md_spellingsuggestions },
 487                 { "submenu", md_submenu },
 488                 { "toc", md_toc },
 489                 { "toolbars", md_toolbars },
 490                 { "updateformats", md_updateformats },
 491                 { "viewformats", md_viewformats }
 492         };
 493
 494         lex.pushTable(menutags);
 495         lex.setContext("MenuDefinition::read: ");
 496
 497         bool quit = false;
 498         bool optional = false;
 499
 500         while (lex.isOK() && !quit) {
 501                 switch (lex.lex()) {
 502                 case md_optitem:
 503                         optional = true;
 504                         // fallback to md_item
 505                 case md_item: {
 506                         lex.next(true);
 507                         docstring const name = translateIfPossible(lex.getDocString());
 508                         lex.next(true);
 509                         string const command = lex.getString();
 510                         FuncRequest func = lyxaction.lookupFunc(command);
 511                         FuncRequest::Origin origin = FuncRequest::MENU;
 512                         if (name_.startsWith("context-toc-"))
 513                                 origin = FuncRequest::TOC;
 514                         add(MenuItem(MenuItem::Command, toqstr(name), func, QString(), optional, origin));
 515                         optional = false;
 516                         break;
 517                 }
 518
 519                 case md_separator:
 520                         add(MenuItem(MenuItem::Separator));
 521                         break;
 522
 523                 case md_lastfiles:
 524                         add(MenuItem(MenuItem::Lastfiles));
 525                         break;
 526
 527                 case md_charstyles:
 528                         add(MenuItem(MenuItem::CharStyles));
 529                         break;
 530
 531                 case md_custom:
 532                         add(MenuItem(MenuItem::Custom));
 533                         break;
 534
 535                 case md_elements:
 536                         add(MenuItem(MenuItem::Elements));
 537                         break;
 538
 539                 case md_documents:
 540                         add(MenuItem(MenuItem::Documents));
 541                         break;
 542
 543                 case md_bookmarks:
 544                         add(MenuItem(MenuItem::Bookmarks));
 545                         break;
 546
 547                 case md_toc:
 548                         add(MenuItem(MenuItem::Toc));
 549                         break;
 550
 551                 case md_viewformats:
 552                         add(MenuItem(MenuItem::ViewFormats));
 553                         break;
 554
 555                 case md_updateformats:
 556                         add(MenuItem(MenuItem::UpdateFormats));
 557                         break;
 558
 559                 case md_exportformats:
 560                         add(MenuItem(MenuItem::ExportFormats));
 561                         break;
 562
 563                 case md_importformats:
 564                         add(MenuItem(MenuItem::ImportFormats));
 565                         break;
 566
 567                 case md_floatlistinsert:
 568                         add(MenuItem(MenuItem::FloatListInsert));
 569                         break;
 570
 571                 case md_floatinsert:
 572                         add(MenuItem(MenuItem::FloatInsert));
 573                         break;
 574
 575                 case md_pasterecent:
 576                         add(MenuItem(MenuItem::PasteRecent));
 577                         break;
 578
 579                 case md_toolbars:
 580                         add(MenuItem(MenuItem::Toolbars));
 581                         break;
 582
 583                 case md_branches:
 584                         add(MenuItem(MenuItem::Branches));
 585                         break;
 586
 587                 case md_citestyles:
 588                         add(MenuItem(MenuItem::CiteStyles));
 589                         break;
 590
 591                 case md_graphicsgroups:
 592                         add(MenuItem(MenuItem::GraphicsGroups));
 593                         break;
 594
 595                 case md_spellingsuggestions:
 596                         add(MenuItem(MenuItem::SpellingSuggestions));
 597                         break;
 598
 599                 case md_languageselector:
 600                         add(MenuItem(MenuItem::LanguageSelector));
 601                         break;
 602
 603                 case md_indices:
 604                         add(MenuItem(MenuItem::Indices));
 605                         break;
 606
 607                 case md_indicescontext:
 608                         add(MenuItem(MenuItem::IndicesContext));
 609                         break;
 610
 611                 case md_indiceslists:
 612                         add(MenuItem(MenuItem::IndicesLists));
 613                         break;
 614
 615                 case md_indiceslistscontext:
 616                         add(MenuItem(MenuItem::IndicesListsContext));
 617                         break;
 618
 619                 case md_optsubmenu:
 620                         optional = true;
 621                         // fallback to md_submenu
 622                 case md_submenu: {
 623                         lex.next(true);
 624                         docstring const mlabel = translateIfPossible(lex.getDocString());
 625                         lex.next(true);
 626                         docstring const mname = lex.getDocString();
 627                         add(MenuItem(MenuItem::Submenu,
 628                                 toqstr(mlabel), toqstr(mname), QString(), optional));
 629                         optional = false;
 630                         break;
 631                 }
 632
 633                 case md_endmenu:
 634                         quit = true;
 635                         break;
 636
 637                 default:
 638                         lex.printError("Unknown menu tag");
 639                         break;
 640                 }
 641         }
 642         lex.popTable();
 643 }
 644
 645
 646 MenuItem const & MenuDefinition::operator[](size_type i) const
 647 {
 648         return items_[i];
 649 }
 650
 651
 652 bool MenuDefinition::hasFunc(FuncRequest const & func) const
 653 {
 654         for (const_iterator it = begin(), et = end(); it != et; ++it)
 655                 if (it->func() == func)
 656                         return true;
 657         return false;
 658 }
 659
 660
 661 void MenuDefinition::catSub(docstring const & name)
 662 {
 663         add(MenuItem(MenuItem::Submenu,
 664                      qt_("More...|M"), toqstr(name), QString(), false));
 665 }
 666
 667 void MenuDefinition::cat(MenuDefinition const & other)
 668 {
 669         const_iterator et = other.end();
 670         for (const_iterator it = other.begin(); it != et; ++it)
 671                 add(*it);
 672 }
 673
 674
 675 void MenuDefinition::checkShortcuts() const
 676 {
 677         // This is a quadratic algorithm, but we do not care because
 678         // menus are short enough
 679         for (const_iterator it1 = begin(); it1 != end(); ++it1) {
 680                 QString shortcut = it1->shortcut();
 681                 if (shortcut.isEmpty())
 682                         continue;
 683                 if (!it1->label().contains(shortcut))
 684                         LYXERR0("Menu warning: menu entry \""
 685                                << it1->label()
 686                                << "\" does not contain shortcut `"
 687                                << shortcut << "'.");
 688                 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
 689                         if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
 690                                 LYXERR0("Menu warning: menu entries "
 691                                        << '"' << it1->fulllabel()
 692                                        << "\" and \"" << it2->fulllabel()
 693                                        << "\" share the same shortcut.");
 694                         }
 695                 }
 696         }
 697 }
 698
 699
 700 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
 701 {
 702         const_iterator m = begin();
 703         const_iterator m_end = end();
 704         for (; m != m_end; ++m) {
 705                 if (m->kind() == MenuItem::Command && m->func() == func) {
 706                         names.push_back(qstring_to_ucs4(m->label()));
 707                         return true;
 708                 }
 709                 if (m->kind() == MenuItem::Submenu) {
 710                         names.push_back(qstring_to_ucs4(m->label()));
 711                         if (!m->hasSubmenu()) {
 712                                 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
 713                                         << m->label() << " name=" << m->submenuname());
 714                                 names.pop_back();
 715                                 continue;
 716                         }
 717                         if (m->submenu().searchMenu(func, names))
 718                                 return true;
 719                         names.pop_back();
 720                 }
 721         }
 722         return false;
 723 }
 724
 725
 726 bool compareFormat(Format const * p1, Format const * p2)
 727 {
 728         return *p1 < *p2;
 729 }
 730
 731
 732 QString limitStringLength(docstring const & str)
 733 {
 734         size_t const max_item_length = 45;
 735
 736         if (str.size() > max_item_length)
 737                 return toqstr(str.substr(0, max_item_length - 3) + "...");
 738
 739         return toqstr(str);
 740 }
 741
 742
 743 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
 744 {
 745         if (!bv)
 746                 return;
 747         set<string> grp;
 748         graphics::getGraphicsGroups(bv->buffer(), grp);
 749         if (grp.empty())
 750                 return;
 751
 752         set<string>::const_iterator it = grp.begin();
 753         set<string>::const_iterator end = grp.end();
 754         add(MenuItem(MenuItem::Command, qt_("No Group"),
 755                      FuncRequest(LFUN_SET_GRAPHICS_GROUP)));
 756         for (; it != end; it++) {
 757                 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it) + '|',
 758                                 FuncRequest(LFUN_SET_GRAPHICS_GROUP, *it)));
 759         }
 760 }
 761
 762
 763 void MenuDefinition::expandSpellingSuggestions(BufferView const * bv)
 764 {
 765         if (!bv)
 766                 return;
 767         WordLangTuple wl;
 768         docstring_list suggestions;
 769         Cursor const & cur = bv->cursor();
 770         Paragraph const & par = cur.paragraph();
 771         pos_type from = cur.pos();
 772         pos_type to = from;
 773         SpellChecker::Result res = par.spellCheck(from, to, wl, suggestions, true, true);
 774         switch (res) {
 775         case SpellChecker::UNKNOWN_WORD:
 776                 if (lyxrc.spellcheck_continuously) {
 777                         LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
 778                         docstring const & selection = cur.selectionAsString(false);
 779                         if (!cur.selection() || selection == wl.word()) {
 780                                 size_t i = 0;
 781                                 size_t m = 10; // first submenu index
 782                                 MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
 783                                 item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
 784                                 for (; i != suggestions.size(); ++i) {
 785                                         docstring const & suggestion = suggestions[i];
 786                                         LYXERR(Debug::GUI, suggestion);
 787                                         MenuItem w(MenuItem::Command, toqstr(suggestion),
 788                                                 FuncRequest(LFUN_WORD_REPLACE,
 789                                                         replace2string(suggestion,selection,
 790                                                                 true, true, false, false)));
 791                                         if (i < m)
 792                                                 add(w);
 793                                         else
 794                                                 item.submenu().add(w);
 795                                 }
 796                                 if (i > m)
 797                                         add(item);
 798                                 if (i > 0)
 799                                         add(MenuItem(MenuItem::Separator));
 800                                 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
 801                                 add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|n"),
 802                                                 FuncRequest(LFUN_SPELLING_ADD, arg)));
 803                                 add(MenuItem(MenuItem::Command, qt_("Ignore all|I"),
 804                                                 FuncRequest(LFUN_SPELLING_IGNORE, arg)));
 805                         }
 806                 }
 807                 break;
 808         case SpellChecker::LEARNED_WORD: {
 809                         LYXERR(Debug::GUI, "Learned Word.");
 810                         docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
 811                         add(MenuItem(MenuItem::Command, qt_("Remove from personal dictionary|r"),
 812                                         FuncRequest(LFUN_SPELLING_REMOVE, arg)));
 813                 }
 814                 break;
 815         case SpellChecker::WORD_OK:
 816         case SpellChecker::COMPOUND_WORD:
 817         case SpellChecker::ROOT_FOUND:
 818         case SpellChecker::IGNORED_WORD:
 819                 break;
 820         }
 821 }
 822
 823 struct sortLanguageByName {
 824         bool operator()(const Language * a, const Language * b) const {
 825                 return qt_(a->display()).localeAwareCompare(qt_(b->display())) < 0;
 826         }
 827 };
 828
 829 void MenuDefinition::expandLanguageSelector(Buffer const * buf)
 830 {
 831         if (!buf)
 832                 return;
 833
 834         std::set<Language const *> languages_buffer =
 835                 buf->masterBuffer()->getLanguages();
 836
 837         if (languages_buffer.size() < 2)
 838                 return;
 839
 840         std::set<Language const *, sortLanguageByName> languages;
 841
 842         std::set<Language const *>::const_iterator const beg =
 843                 languages_buffer.begin();
 844         for (std::set<Language const *>::const_iterator cit = beg;
 845              cit != languages_buffer.end(); ++cit) {
 846                 languages.insert(*cit);
 847         }
 848
 849         MenuItem item(MenuItem::Submenu, qt_("Language|L"));
 850         item.setSubmenu(MenuDefinition(qt_("Language")));
 851         QString morelangs = qt_("More Languages ...|M");
 852         QStringList accelerators;
 853         if (morelangs.contains('|'))
 854                 accelerators.append(morelangs.section('|', -1));
 855         std::set<Language const *, sortLanguageByName>::const_iterator const begin = languages.begin();
 856         for (std::set<Language const *, sortLanguageByName>::const_iterator cit = begin;
 857              cit != languages.end(); ++cit) {
 858                 QString label = qt_((*cit)->display());
 859                 // try to add an accelerator
 860                 bool success = false;
 861                 // try capitals first
 862                 for (int i = 0; i < label.size(); ++i) {
 863                         QChar const ch = label[i];
 864                         if (!ch.isUpper())
 865                                 continue;
 866                         if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
 867                                 label = label + toqstr("|") + ch;
 868                                 accelerators.append(ch);
 869                                 success = true;
 870                                 break;
 871                         }
 872                 }
 873                 // if all capitals are taken, try the rest
 874                 if (!success) {
 875                         for (int i = 0; i < label.size(); ++i) {
 876                                 if (label[i].isSpace())
 877                                         continue;
 878                                 QString const ch = QString(label[i]);
 879                                 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
 880                                         label = label + toqstr("|") + ch;
 881                                         accelerators.append(ch);
 882                                         break;
 883                                 }
 884                         }
 885                 }
 886                 MenuItem w(MenuItem::Command, label,
 887                         FuncRequest(LFUN_LANGUAGE, (*cit)->lang()));
 888                 item.submenu().addWithStatusCheck(w);
 889         }
 890         item.submenu().add(MenuItem(MenuItem::Separator));
 891         item.submenu().add(MenuItem(MenuItem::Command, morelangs,
 892                         FuncRequest(LFUN_DIALOG_SHOW, "character")));
 893         add(item);
 894 }
 895
 896
 897 void MenuDefinition::expandLastfiles()
 898 {
 899         LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
 900         LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
 901
 902         unsigned int ii = 1;
 903
 904         for (; lfit != lf.end() && ii <= lyxrc.num_lastfiles; ++lfit, ++ii) {
 905                 string const file = lfit->absFileName();
 906                 QString const short_path = toqstr(makeDisplayPath(file, 30));
 907                 QString const long_path = toqstr(makeDisplayPath(file));
 908                 QString label;
 909                 if (ii < 10)
 910                         label = QString("%1. %2|%3").arg(ii).arg(short_path).arg(ii);
 911                 else
 912                         label = QString("%1. %2").arg(ii).arg(short_path);
 913                 add(MenuItem(MenuItem::Command, label,
 914                         FuncRequest(LFUN_FILE_OPEN, file), long_path));
 915         }
 916 }
 917
 918
 919 void MenuDefinition::expandDocuments()
 920 {
 921         MenuItem item(MenuItem::Submenu, qt_("Hidden|H"));
 922         item.setSubmenu(MenuDefinition(qt_("Hidden|H")));
 923
 924         Buffer * first = theBufferList().first();
 925         if (!first) {
 926                 add(MenuItem(MenuItem::Info, qt_("<No Documents Open>")));
 927                 return;
 928         }
 929
 930         int i = 0;
 931         while (true) {
 932                 if (!guiApp->currentView())
 933                         break;
 934                 GuiWorkArea * wa = guiApp->currentView()->workArea(i);
 935                 if (!wa)
 936                         break;
 937                 Buffer const & b = wa->bufferView().buffer();
 938                 QString label = toqstr(b.fileName().displayName(20));
 939                 if (!b.isClean())
 940                         label += "*";
 941                 if (i < 10)
 942                         label = QString::number(i) + ". " + label + '|' + QString::number(i);
 943                 add(MenuItem(MenuItem::Command, label,
 944                         FuncRequest(LFUN_BUFFER_SWITCH, b.absFileName())));
 945                 ++i;
 946         }
 947
 948
 949         i = 0;
 950         Buffer * b = first;
 951         // We cannot use a for loop as the buffer list cycles.
 952         do {
 953                 bool const shown = guiApp->currentView()
 954                         ? guiApp->currentView()->workArea(*b) : false;
 955                 if (!shown) {
 956                         QString label = toqstr(b->fileName().displayName(20));
 957                         if (!b->isClean())
 958                                 label += "*";
 959                         if (i < 10)
 960                                 label = QString::number(i) + ". " + label + '|' + QString::number(i);
 961                         item.submenu().add(MenuItem(MenuItem::Command, label,
 962                                 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
 963                         ++i;
 964                 }
 965                 b = theBufferList().next(b);
 966         } while (b != first);
 967
 968         if (!item.submenu().empty())
 969                 add(item);
 970 }
 971
 972
 973 void MenuDefinition::expandBookmarks()
 974 {
 975         lyx::BookmarksSection const & bm = theSession().bookmarks();
 976
 977         bool empty = true;
 978         for (size_t i = 1; i <= bm.size(); ++i) {
 979                 if (bm.isValid(i)) {
 980                         string const file = bm.bookmark(i).filename.absFileName();
 981                         QString const label = QString("%1. %2|%3").arg(i)
 982                                 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
 983                         add(MenuItem(MenuItem::Command, label,
 984                                 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
 985                         empty = false;
 986                 }
 987         }
 988         if (empty)
 989                 add(MenuItem(MenuItem::Info, qt_("<No Bookmarks Saved Yet>")));
 990 }
 991
 992
 993 void MenuDefinition::expandFormats(MenuItem::Kind kind, Buffer const * buf)
 994 {
 995         if (!buf && kind != MenuItem::ImportFormats)
 996                 return;
 997
 998         typedef vector<Format const *> Formats;
 999         Formats formats;
1000         FuncCode action;
1001
1002         switch (kind) {
1003         case MenuItem::ImportFormats:
1004                 formats = theConverters().importableFormats();
1005                 action = LFUN_BUFFER_IMPORT;
1006                 break;
1007         case MenuItem::ViewFormats:
1008                 formats = buf->exportableFormats(true);
1009                 action = LFUN_BUFFER_VIEW;
1010                 break;
1011         case MenuItem::UpdateFormats:
1012                 formats = buf->exportableFormats(true);
1013                 action = LFUN_BUFFER_UPDATE;
1014                 break;
1015         default:
1016                 formats = buf->exportableFormats(false);
1017                 action = LFUN_BUFFER_EXPORT;
1018         }
1019         sort(formats.begin(), formats.end(), &compareFormat);
1020
1021         bool const view_update = (kind == MenuItem::ViewFormats
1022                         || kind == MenuItem::UpdateFormats);
1023
1024         QString smenue;
1025         if (view_update)
1026                 smenue = (kind == MenuItem::ViewFormats ?
1027                         qt_("View (Other Formats)|F")
1028                         : qt_("Update (Other Formats)|p"));
1029         MenuItem item(MenuItem::Submenu, smenue);
1030         item.setSubmenu(MenuDefinition(smenue));
1031
1032         Formats::const_iterator fit = formats.begin();
1033         Formats::const_iterator end = formats.end();
1034         for (; fit != end ; ++fit) {
1035                 if ((*fit)->dummy())
1036                         continue;
1037
1038                 docstring lab = from_utf8((*fit)->prettyname());
1039                 docstring scut = from_utf8((*fit)->shortcut());
1040                 docstring const tmplab = lab;
1041
1042                 if (!scut.empty())
1043                         lab += char_type('|') + scut;
1044                 docstring lab_i18n = translateIfPossible(lab);
1045                 bool const untranslated = (lab == lab_i18n);
1046                 QString const shortcut = toqstr(split(lab_i18n, lab, '|'));
1047                 QString label = toqstr(lab);
1048                 if (untranslated)
1049                         // this might happen if the shortcut
1050                         // has been redefined
1051                         label = toqstr(translateIfPossible(tmplab));
1052
1053                 switch (kind) {
1054                 case MenuItem::ImportFormats:
1055                         label += "...";
1056                         break;
1057                 case MenuItem::ViewFormats:
1058                 case MenuItem::UpdateFormats:
1059                         if ((*fit)->name() == buf->getDefaultOutputFormat()) {
1060                                 docstring lbl = (kind == MenuItem::ViewFormats ?
1061                                         bformat(_("View [%1$s]|V"), qstring_to_ucs4(label))
1062                                         : bformat(_("Update [%1$s]|U"), qstring_to_ucs4(label)));
1063                                 MenuItem w(MenuItem::Command, toqstr(lbl),
1064                                            FuncRequest(action));
1065                                 add(w);
1066                                 continue;
1067                         }
1068                 case MenuItem::ExportFormats:
1069                         if (!(*fit)->inExportMenu())
1070                                 continue;
1071                         break;
1072                 default:
1073                         LASSERT(false, /**/);
1074                         break;
1075                 }
1076                 if (!shortcut.isEmpty())
1077                         label += '|' + shortcut;
1078
1079                 if (view_update) {
1080                         if (buf)
1081                                 item.submenu().addWithStatusCheck(MenuItem(MenuItem::Command, label,
1082                                         FuncRequest(action, (*fit)->name())));
1083                         else
1084                                 item.submenu().add(MenuItem(MenuItem::Command, label,
1085                                         FuncRequest(action, (*fit)->name())));
1086                 } else {
1087                         if (buf)
1088                                 addWithStatusCheck(MenuItem(MenuItem::Command, label,
1089                                         FuncRequest(action, (*fit)->name())));
1090                         else
1091                                 add(MenuItem(MenuItem::Command, label,
1092                                         FuncRequest(action, (*fit)->name())));
1093                 }
1094         }
1095         if (view_update)
1096                 add(item);
1097 }
1098
1099
1100 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
1101 {
1102         if (!buf)
1103                 return;
1104
1105         FloatList const & floats = buf->params().documentClass().floats();
1106         FloatList::const_iterator cit = floats.begin();
1107         FloatList::const_iterator end = floats.end();
1108         set<string> seen;
1109         for (; cit != end; ++cit) {
1110                 if (!cit->second.usesFloatPkg()) {
1111                         // Different floats could declare the same ListCommand. We only
1112                         // want it on the list once, though.
1113                         string const & list_cmd = cit->second.listCommand();
1114                         if (list_cmd.empty())
1115                                 // we do not know how to generate such a list
1116                                 continue;
1117                         // This form of insert returns an iterator pointing to the newly
1118                         // inserted element OR the existing element with that value, and
1119                         // a bool indicating whether we inserted a new element. So we can
1120                         // see if one is there and insert it if not all at once.
1121                         pair<set<string>::iterator, bool> ret = seen.insert(list_cmd);
1122                         if (!ret.second)
1123                                 continue;
1124                 }
1125                 string const & list_name = cit->second.listName();
1126                 addWithStatusCheck(MenuItem(MenuItem::Command, qt_(list_name),
1127                         FuncRequest(LFUN_FLOAT_LIST_INSERT, cit->second.floattype())));
1128         }
1129 }
1130
1131
1132 void MenuDefinition::expandFloatInsert(Buffer const * buf)
1133 {
1134         if (!buf)
1135                 return;
1136
1137         FloatList const & floats = buf->params().documentClass().floats();
1138         FloatList::const_iterator cit = floats.begin();
1139         FloatList::const_iterator end = floats.end();
1140         for (; cit != end; ++cit) {
1141                 // normal float
1142                 QString const label = qt_(cit->second.name());
1143                 addWithStatusCheck(MenuItem(MenuItem::Command, label,
1144                                     FuncRequest(LFUN_FLOAT_INSERT,
1145                                                 cit->second.floattype())));
1146         }
1147 }
1148
1149
1150 void MenuDefinition::expandFlexInsert(
1151                 Buffer const * buf, InsetLayout::InsetLyXType type)
1152 {
1153         if (!buf)
1154                 return;
1155
1156         TextClass::InsetLayouts const & insetLayouts =
1157                 buf->params().documentClass().insetLayouts();
1158         TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
1159         TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
1160         for (; cit != end; ++cit) {
1161                 if (cit->second.lyxtype() == type) {
1162                         docstring label = cit->first;
1163                         // we remove the "Flex:" prefix, if it is present
1164                         if (prefixIs(label, from_utf8("Flex:")))
1165                                 label = label.substr(5);
1166                         addWithStatusCheck(MenuItem(MenuItem::Command,
1167                                 toqstr(translateIfPossible(label)),
1168                                 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(label))));
1169                 }
1170         }
1171         // FIXME This is a little clunky.
1172         if (items_.empty() && type == InsetLayout::CUSTOM)
1173                 add(MenuItem(MenuItem::Help, qt_("No Custom Insets Defined!")));
1174 }
1175
1176
1177 size_t const max_number_of_items = 25;
1178
1179 void MenuDefinition::expandToc2(Toc const & toc_list,
1180                 size_t from, size_t to, int depth)
1181 {
1182         int shortcut_count = 0;
1183
1184         // check whether depth is smaller than the smallest depth in toc.
1185         int min_depth = 1000;
1186         for (size_t i = from; i < to; ++i)
1187                 min_depth = min(min_depth, toc_list[i].depth());
1188         if (min_depth > depth)
1189                 depth = min_depth;
1190
1191         if (to - from <= max_number_of_items) {
1192                 for (size_t i = from; i < to; ++i) {
1193                         QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
1194                         label += limitStringLength(toc_list[i].str());
1195                         if (toc_list[i].depth() == depth) {
1196                                 label += '|';
1197                             if (shortcut_count < 9) {
1198                                         if (label.contains(QString::number(shortcut_count + 1)))
1199                                                 label += QString::number(++shortcut_count);
1200                                 }
1201                         }
1202                         add(MenuItem(MenuItem::Command, label,
1203                                             FuncRequest(toc_list[i].action())));
1204                 }
1205         } else {
1206                 size_t pos = from;
1207                 while (pos < to) {
1208                         size_t new_pos = pos + 1;
1209                         while (new_pos < to && toc_list[new_pos].depth() > depth)
1210                                 ++new_pos;
1211
1212                         QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
1213                         label += limitStringLength(toc_list[pos].str());
1214                         if (toc_list[pos].depth() == depth) {
1215                                 label += '|';
1216                             if (shortcut_count < 9) {
1217                                         if (label.contains(QString::number(shortcut_count + 1)))
1218                                                 label += QString::number(++shortcut_count);
1219                                 }
1220                         }
1221                         if (new_pos == pos + 1) {
1222                                 add(MenuItem(MenuItem::Command,
1223                                                     label, FuncRequest(toc_list[pos].action())));
1224                         } else {
1225                                 MenuDefinition sub;
1226                                 sub.expandToc2(toc_list, pos, new_pos, depth + 1);
1227                                 MenuItem item(MenuItem::Submenu, label);
1228                                 item.setSubmenu(sub);
1229                                 add(item);
1230                         }
1231                         pos = new_pos;
1232                 }
1233         }
1234 }
1235
1236
1237 void MenuDefinition::expandToc(Buffer const * buf)
1238 {
1239         // To make things very cleanly, we would have to pass buf to
1240         // all MenuItem constructors and to expandToc2. However, we
1241         // know that all the entries in a TOC will be have status_ ==
1242         // OK, so we avoid this unnecessary overhead (JMarc)
1243
1244         if (!buf) {
1245                 add(MenuItem(MenuItem::Info, qt_("<No Document Open>")));
1246                 return;
1247         }
1248
1249         // Add an entry for the master doc if this is a child doc
1250         Buffer const * const master = buf->masterBuffer();
1251         if (buf != master) {
1252                 ParIterator const pit = par_iterator_begin(master->inset());
1253                 string const arg = convert<string>(pit->id());
1254                 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
1255                 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
1256         }
1257
1258         MenuDefinition other_lists;
1259
1260         FloatList const & floatlist = buf->params().documentClass().floats();
1261         TocList const & toc_list = buf->tocBackend().tocs();
1262         TocList::const_iterator cit = toc_list.begin();
1263         TocList::const_iterator end = toc_list.end();
1264         for (; cit != end; ++cit) {
1265                 // Handle this later
1266                 if (cit->first == "tableofcontents")
1267                         continue;
1268
1269                 MenuDefinition submenu;
1270                 if (cit->second.size() >= 30) {
1271                         FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
1272                         submenu.add(MenuItem(MenuItem::Command, qt_("Open Navigator..."), f));
1273                 } else {
1274                         TocIterator ccit = cit->second.begin();
1275                         TocIterator eend = cit->second.end();
1276                         for (; ccit != eend; ++ccit) {
1277                                 submenu.add(MenuItem(MenuItem::Command,
1278                                         limitStringLength(ccit->str()) + '|',
1279                                         FuncRequest(ccit->action())));
1280                         }
1281                 }
1282
1283                 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
1284                 item.setSubmenu(submenu);
1285                 if (floatlist.typeExist(cit->first) || cit->first == "child") {
1286                         // Those two types deserve to be in the main menu.
1287                         item.setSubmenu(submenu);
1288                         add(item);
1289                 } else
1290                         other_lists.add(item);
1291         }
1292         if (!other_lists.empty()) {
1293                 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
1294                 item.setSubmenu(other_lists);
1295                 add(item);
1296         }
1297
1298         // Handle normal TOC
1299         cit = toc_list.find("tableofcontents");
1300         if (cit == end)
1301                 LYXERR(Debug::GUI, "No table of contents.");
1302         else {
1303                 if (cit->second.size() > 0 )
1304                         expandToc2(cit->second, 0, cit->second.size(), 0);
1305                 else
1306                         add(MenuItem(MenuItem::Info, qt_("<Empty Table of Contents>")));
1307         }
1308 }
1309
1310
1311 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1312 {
1313         docstring_list const sel = cap::availableSelections(buf);
1314
1315         docstring_list::const_iterator cit = sel.begin();
1316         docstring_list::const_iterator end = sel.end();
1317
1318         for (unsigned int index = 0; cit != end; ++cit, ++index) {
1319                 add(MenuItem(MenuItem::Command, toqstr(*cit) + '|',
1320                                     FuncRequest(LFUN_PASTE, convert<string>(index))));
1321         }
1322 }
1323
1324
1325 void MenuDefinition::expandToolbars()
1326 {
1327         MenuDefinition other_lists;
1328         // extracts the toolbars from the backend
1329         Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1330         Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1331         for (; cit != end; ++cit) {
1332                 MenuItem const item(MenuItem::Command, toqstr(cit->gui_name),
1333                                 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1334                 if (guiApp->toolbars().isMainToolbar(cit->name))
1335                         add(item);
1336                 else
1337                         other_lists.add(item);
1338         }
1339
1340         if (!other_lists.empty()) {
1341                 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1342                 item.setSubmenu(other_lists);
1343                 add(item);
1344         }
1345 }
1346
1347
1348 void MenuDefinition::expandBranches(Buffer const * buf)
1349 {
1350         if (!buf)
1351                 return;
1352
1353         BufferParams const & master_params = buf->masterBuffer()->params();
1354         BufferParams const & params = buf->params();
1355         if (params.branchlist().empty() && master_params.branchlist().empty() ) {
1356                 add(MenuItem(MenuItem::Help, qt_("No Branches Set for Document!")));
1357                 return;
1358         }
1359
1360         BranchList::const_iterator cit = master_params.branchlist().begin();
1361         BranchList::const_iterator end = master_params.branchlist().end();
1362
1363         for (int ii = 1; cit != end; ++cit, ++ii) {
1364                 docstring label = cit->branch();
1365                 if (ii < 10) {
1366                         label = convert<docstring>(ii) + ". " + label
1367                                 + char_type('|') + convert<docstring>(ii);
1368                 }
1369                 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1370                                     FuncRequest(LFUN_BRANCH_INSERT,
1371                                                 cit->branch())));
1372         }
1373
1374         if (buf == buf->masterBuffer())
1375                 return;
1376
1377         MenuDefinition child_branches;
1378
1379         BranchList::const_iterator ccit = params.branchlist().begin();
1380         BranchList::const_iterator cend = params.branchlist().end();
1381
1382         for (int ii = 1; ccit != cend; ++ccit, ++ii) {
1383                 docstring label = ccit->branch();
1384                 if (ii < 10) {
1385                         label = convert<docstring>(ii) + ". " + label
1386                                 + char_type('|') + convert<docstring>(ii);
1387                 } else
1388                         label += char_type('|');
1389                 child_branches.addWithStatusCheck(MenuItem(MenuItem::Command,
1390                                     toqstr(label),
1391                                     FuncRequest(LFUN_BRANCH_INSERT,
1392                                                 ccit->branch())));
1393         }
1394
1395         if (!child_branches.empty()) {
1396                 MenuItem item(MenuItem::Submenu, qt_("Child Document"));
1397                 item.setSubmenu(child_branches);
1398                 add(item);
1399         }
1400 }
1401
1402
1403 void MenuDefinition::expandIndices(Buffer const * buf, bool listof)
1404 {
1405         if (!buf)
1406                 return;
1407
1408         BufferParams const & params = buf->masterBuffer()->params();
1409         if (!params.use_indices) {
1410                 if (listof)
1411                         addWithStatusCheck(MenuItem(MenuItem::Command,
1412                                            qt_("Index List|I"),
1413                                            FuncRequest(LFUN_INDEX_PRINT,
1414                                                   from_ascii("idx"))));
1415                 else
1416                         addWithStatusCheck(MenuItem(MenuItem::Command,
1417                                            qt_("Index Entry|d"),
1418                                            FuncRequest(LFUN_INDEX_INSERT,
1419                                                   from_ascii("idx"))));
1420                 return;
1421         }
1422
1423         if (params.indiceslist().empty())
1424                 return;
1425
1426         IndicesList::const_iterator cit = params.indiceslist().begin();
1427         IndicesList::const_iterator end = params.indiceslist().end();
1428
1429         for (int ii = 1; cit != end; ++cit, ++ii) {
1430                 if (listof) {
1431                         docstring const label =
1432                                 bformat(_("Index: %1$s"), cit->index());
1433                         addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1434                                            FuncRequest(LFUN_INDEX_PRINT, cit->shortcut())));
1435                 } else {
1436                         docstring const label =
1437                                 bformat(_("Index Entry (%1$s)"), cit->index());
1438                         addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1439                                            FuncRequest(LFUN_INDEX_INSERT, cit->shortcut())));
1440                 }
1441         }
1442 }
1443
1444
1445 void MenuDefinition::expandIndicesContext(Buffer const * buf, bool listof)
1446 {
1447         if (!buf)
1448                 return;
1449
1450         BufferParams const & params = buf->masterBuffer()->params();
1451         if (!params.use_indices || params.indiceslist().empty())
1452                 return;
1453
1454         IndicesList::const_iterator cit = params.indiceslist().begin();
1455         IndicesList::const_iterator end = params.indiceslist().end();
1456
1457         for (int ii = 1; cit != end; ++cit, ++ii) {
1458                 if (listof) {
1459                         InsetCommandParams p(INDEX_PRINT_CODE);
1460                         p["type"] = cit->shortcut();
1461                         string const data = InsetCommand::params2string(p);
1462                         addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
1463                                            FuncRequest(LFUN_INSET_MODIFY, data)));
1464                 } else {
1465                         docstring const label =
1466                                         bformat(_("Index Entry (%1$s)"), cit->index());
1467                         addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1468                                            FuncRequest(LFUN_INSET_MODIFY,
1469                                                   from_ascii("changetype ") + cit->shortcut())));
1470                 }
1471         }
1472 }
1473
1474
1475 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1476 {
1477         if (!bv)
1478                 return;
1479
1480         Inset const * inset = bv->cursor().nextInset();
1481         if (!inset || inset->lyxCode() != CITE_CODE) {
1482                 add(MenuItem(MenuItem::Command,
1483                                     qt_("No Citation in Scope!"),
1484                                     FuncRequest(LFUN_NOACTION)));
1485                 return;
1486         }
1487         InsetCommand const * citinset =
1488                                 static_cast<InsetCommand const *>(inset);
1489
1490         Buffer const * buf = &bv->buffer();
1491         docstring key = citinset->getParam("key");
1492         // we can only handle one key currently
1493         if (contains(key, ','))
1494                 key = qstring_to_ucs4(toqstr(key).split(',')[0]);
1495
1496         vector<CiteStyle> citeStyleList = citeStyles(buf->params().citeEngine());
1497         docstring_list citeStrings =
1498                 buf->masterBibInfo().getCiteStrings(key, bv->buffer());
1499
1500         docstring_list::const_iterator cit = citeStrings.begin();
1501         docstring_list::const_iterator end = citeStrings.end();
1502
1503         for (int ii = 1; cit != end; ++cit, ++ii) {
1504                 docstring label = *cit;
1505                 CitationStyle cs;
1506                 CiteStyle cst = citeStyleList[ii - 1];
1507                 cs.style = cst;
1508                 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1509                                     FuncRequest(LFUN_INSET_MODIFY,
1510                                                 "changetype " + from_utf8(citationStyleToString(cs)))));
1511         }
1512 }
1513
1514 } // namespace anon
1515
1516
1517 /////////////////////////////////////////////////////////////////////
1518 // Menu::Impl definition and implementation
1519 /////////////////////////////////////////////////////////////////////
1520
1521 struct Menu::Impl
1522 {
1523         /// populates the menu or one of its submenu
1524         /// This is used as a recursive function
1525         void populate(QMenu & qMenu, MenuDefinition const & menu);
1526
1527         /// Only needed for top level menus.
1528         MenuDefinition * top_level_menu;
1529         /// our owning view
1530         GuiView * view;
1531         /// the name of this menu
1532         QString name;
1533 };
1534
1535
1536
1537 /// Get a MenuDefinition item label from the menu backend
1538 static QString label(MenuItem const & mi)
1539 {
1540         QString label = mi.label();
1541         label.replace("&", "&&");
1542
1543         QString shortcut = mi.shortcut();
1544         if (!shortcut.isEmpty()) {
1545                 int pos = label.indexOf(shortcut);
1546                 if (pos != -1)
1547                         //label.insert(pos, 1, char_type('&'));
1548                         label.replace(pos, 0, "&");
1549         }
1550
1551         QString const binding = mi.binding();
1552         if (!binding.isEmpty())
1553                 label += '\t' + binding;
1554
1555         return label;
1556 }
1557
1558 void Menu::Impl::populate(QMenu & qMenu, MenuDefinition const & menu)
1559 {
1560         LYXERR(Debug::GUI, "populating menu " << menu.name());
1561         if (menu.size() == 0) {
1562                 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
1563                 return;
1564         }
1565         LYXERR(Debug::GUI, " *****  menu entries " << menu.size());
1566         MenuDefinition::const_iterator m = menu.begin();
1567         MenuDefinition::const_iterator end = menu.end();
1568         for (; m != end; ++m) {
1569                 if (m->kind() == MenuItem::Separator)
1570                         qMenu.addSeparator();
1571                 else if (m->kind() == MenuItem::Submenu) {
1572                         QMenu * subMenu = qMenu.addMenu(label(*m));
1573                         populate(*subMenu, m->submenu());
1574                         subMenu->setEnabled(m->status().enabled());
1575                 } else {
1576                         // we have a MenuItem::Command
1577                         qMenu.addAction(new Action(view, QIcon(), label(*m),
1578                                 m->func(), m->tooltip(), &qMenu));
1579                 }
1580         }
1581 }
1582
1583 #if defined(Q_WS_WIN) && (QT_VERSION >= 0x040600)
1584 class AlwaysMnemonicStyle : public QProxyStyle {
1585 public:
1586         int styleHint(StyleHint hint, const QStyleOption *opt = 0, const QWidget *widget = 0,
1587                 QStyleHintReturn *returnData = 0) const
1588         {
1589                 if (hint == QStyle::SH_UnderlineShortcut)
1590                         return 1;
1591                 return QProxyStyle::styleHint(hint, opt, widget, returnData);
1592         }
1593 };
1594 #endif
1595
1596 /////////////////////////////////////////////////////////////////////
1597 // Menu implementation
1598 /////////////////////////////////////////////////////////////////////
1599
1600 Menu::Menu(GuiView * gv, QString const & name, bool top_level, bool keyboard)
1601 : QMenu(gv), d(new Menu::Impl)
1602 {
1603 #if defined(Q_WS_WIN) && (QT_VERSION >= 0x040600)
1604         if (keyboard)
1605                 setStyle(new AlwaysMnemonicStyle);
1606 #else
1607         (void) keyboard;
1608 #endif
1609         d->top_level_menu = top_level? new MenuDefinition : 0;
1610         d->view = gv;
1611         d->name = name;
1612         setTitle(name);
1613         if (d->top_level_menu)
1614                 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1615 }
1616
1617
1618 Menu::~Menu()
1619 {
1620         delete d->top_level_menu;
1621         delete d;
1622 }
1623
1624
1625 void Menu::updateView()
1626 {
1627         guiApp->menus().updateMenu(this);
1628 }
1629
1630
1631 /////////////////////////////////////////////////////////////////////
1632 // Menus::Impl definition and implementation
1633 /////////////////////////////////////////////////////////////////////
1634
1635 struct Menus::Impl {
1636         ///
1637         bool hasMenu(QString const &) const;
1638         ///
1639         MenuDefinition & getMenu(QString const &);
1640         ///
1641         MenuDefinition const & getMenu(QString const &) const;
1642
1643         /// Expands some special entries of the menu
1644         /** The entries with the following kind are expanded to a
1645             sequence of Command MenuItems: Lastfiles, Documents,
1646             ViewFormats, ExportFormats, UpdateFormats, Branches, Indices
1647         */
1648         void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1649                 BufferView const *) const;
1650
1651         /// Initialize specific MACOS X menubar
1652         void macxMenuBarInit(GuiView * view, QMenuBar * qmb);
1653
1654         /// Mac special menu.
1655         /** This defines a menu whose entries list the FuncRequests
1656             that will be removed by expand() in other menus. This is
1657             used by the Qt/Mac code.
1658
1659             NOTE: Qt does not remove the menu items when clearing a QMenuBar,
1660             such that the items will keep accessing the FuncRequests in
1661             the MenuDefinition. While Menus::Impl might be recreated,
1662             we keep mac_special_menu_ in memory by making it static.
1663         */
1664         static MenuDefinition mac_special_menu_;
1665
1666         ///
1667         MenuList menulist_;
1668         ///
1669         MenuDefinition menubar_;
1670
1671         typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
1672
1673         /// name to menu for \c menu() method.
1674         NameMap name_map_;
1675 };
1676
1677
1678 MenuDefinition Menus::Impl::mac_special_menu_;
1679
1680
1681 /*
1682   Here is what the Qt documentation says about how a menubar is chosen:
1683
1684      1) If the window has a QMenuBar then it is used. 2) If the window
1685      is a modal then its menubar is used. If no menubar is specified
1686      then a default menubar is used (as documented below) 3) If the
1687      window has no parent then the default menubar is used (as
1688      documented below).
1689
1690      The above 3 steps are applied all the way up the parent window
1691      chain until one of the above are satisifed. If all else fails a
1692      default menubar will be created, the default menubar on Qt/Mac is
1693      an empty menubar, however you can create a different default
1694      menubar by creating a parentless QMenuBar, the first one created
1695      will thus be designated the default menubar, and will be used
1696      whenever a default menubar is needed.
1697
1698   Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1699   that this menubar will be used also when one of LyX' dialogs has
1700   focus. (JMarc)
1701 */
1702 void Menus::Impl::macxMenuBarInit(GuiView * view, QMenuBar * qmb)
1703 {
1704         /* Since Qt 4.2, the qt/mac menu code has special code for
1705            specifying the role of a menu entry. However, it does not
1706            work very well with our scheme of creating menus on demand,
1707            and therefore we need to put these entries in a special
1708            invisible menu. (JMarc)
1709         */
1710
1711         /* The entries of our special mac menu. If we add support for
1712          * special entries in Menus, we could imagine something
1713          * like
1714          *    SpecialItem About " "About LyX" "dialog-show aboutlyx"
1715          * and therefore avoid hardcoding. I am not sure it is worth
1716          * the hassle, though. (JMarc)
1717          */
1718         struct MacMenuEntry {
1719                 FuncCode action;
1720                 char const * arg;
1721                 char const * label;
1722                 QAction::MenuRole role;
1723         };
1724
1725         MacMenuEntry entries[] = {
1726                 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1727                  QAction::AboutRole},
1728                 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1729                  QAction::PreferencesRole},
1730                 {LFUN_RECONFIGURE, "", "Reconfigure",
1731                  QAction::ApplicationSpecificRole},
1732                 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1733         };
1734         const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1735
1736         // the special menu for Menus. Fill it up only once.
1737         if (mac_special_menu_.size() == 0) {
1738                 for (size_t i = 0 ; i < num_entries ; ++i) {
1739                         FuncRequest const func(entries[i].action,
1740                                 from_utf8(entries[i].arg));
1741                         mac_special_menu_.add(MenuItem(MenuItem::Command,
1742                                 entries[i].label, func));
1743                 }
1744         }
1745
1746         // add the entries to a QMenu that will eventually be empty
1747         // and therefore invisible.
1748         QMenu * qMenu = qmb->addMenu("special");
1749         MenuDefinition::const_iterator cit = mac_special_menu_.begin();
1750         MenuDefinition::const_iterator end = mac_special_menu_.end();
1751         for (size_t i = 0 ; cit != end ; ++cit, ++i) {
1752                 Action * action = new Action(view, QIcon(), cit->label(),
1753                         cit->func(), QString(), qMenu);
1754                 action->setMenuRole(entries[i].role);
1755                 qMenu->addAction(action);
1756         }
1757 }
1758
1759
1760 void Menus::Impl::expand(MenuDefinition const & frommenu,
1761         MenuDefinition & tomenu, BufferView const * bv) const
1762 {
1763         if (!tomenu.empty())
1764                 tomenu.clear();
1765
1766         for (MenuDefinition::const_iterator cit = frommenu.begin();
1767              cit != frommenu.end() ; ++cit) {
1768                 Buffer const * buf = bv ? &bv->buffer() : 0;
1769                 switch (cit->kind()) {
1770                 case MenuItem::Lastfiles:
1771                         tomenu.expandLastfiles();
1772                         break;
1773
1774                 case MenuItem::Documents:
1775                         tomenu.expandDocuments();
1776                         break;
1777
1778                 case MenuItem::Bookmarks:
1779                         tomenu.expandBookmarks();
1780                         break;
1781
1782                 case MenuItem::ImportFormats:
1783                 case MenuItem::ViewFormats:
1784                 case MenuItem::UpdateFormats:
1785                 case MenuItem::ExportFormats:
1786                         tomenu.expandFormats(cit->kind(), buf);
1787                         break;
1788
1789                 case MenuItem::CharStyles:
1790                         tomenu.expandFlexInsert(buf, InsetLayout::CHARSTYLE);
1791                         break;
1792
1793                 case MenuItem::Custom:
1794                         tomenu.expandFlexInsert(buf, InsetLayout::CUSTOM);
1795                         break;
1796
1797                 case MenuItem::Elements:
1798                         tomenu.expandFlexInsert(buf, InsetLayout::ELEMENT);
1799                         break;
1800
1801                 case MenuItem::FloatListInsert:
1802                         tomenu.expandFloatListInsert(buf);
1803                         break;
1804
1805                 case MenuItem::FloatInsert:
1806                         tomenu.expandFloatInsert(buf);
1807                         break;
1808
1809                 case MenuItem::PasteRecent:
1810                         tomenu.expandPasteRecent(buf);
1811                         break;
1812
1813                 case MenuItem::Toolbars:
1814                         tomenu.expandToolbars();
1815                         break;
1816
1817                 case MenuItem::Branches:
1818                         tomenu.expandBranches(buf);
1819                         break;
1820
1821                 case MenuItem::Indices:
1822                         tomenu.expandIndices(buf);
1823                         break;
1824
1825                 case MenuItem::IndicesContext:
1826                         tomenu.expandIndicesContext(buf);
1827                         break;
1828
1829                 case MenuItem::IndicesLists:
1830                         tomenu.expandIndices(buf, true);
1831                         break;
1832
1833                 case MenuItem::IndicesListsContext:
1834                         tomenu.expandIndicesContext(buf, true);
1835                         break;
1836
1837                 case MenuItem::CiteStyles:
1838                         tomenu.expandCiteStyles(bv);
1839                         break;
1840
1841                 case MenuItem::Toc:
1842                         tomenu.expandToc(buf);
1843                         break;
1844
1845                 case MenuItem::GraphicsGroups:
1846                         tomenu.expandGraphicsGroups(bv);
1847                         break;
1848
1849                 case MenuItem::SpellingSuggestions:
1850                         tomenu.expandSpellingSuggestions(bv);
1851                         break;
1852
1853                 case MenuItem::LanguageSelector:
1854                         tomenu.expandLanguageSelector(buf);
1855                         break;
1856
1857                 case MenuItem::Submenu: {
1858                         MenuItem item(*cit);
1859                         item.setSubmenu(MenuDefinition(cit->submenuname()));
1860                         expand(getMenu(cit->submenuname()), item.submenu(), bv);
1861                         tomenu.addWithStatusCheck(item);
1862                 }
1863                 break;
1864
1865                 case MenuItem::Info:
1866                 case MenuItem::Help:
1867                 case MenuItem::Separator:
1868                         tomenu.addWithStatusCheck(*cit);
1869                         break;
1870
1871                 case MenuItem::Command:
1872                         if (!mac_special_menu_.hasFunc(cit->func()))
1873                                 tomenu.addWithStatusCheck(*cit);
1874                 }
1875         }
1876
1877         // we do not want the menu to end with a separator
1878         if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
1879                 tomenu.items_.pop_back();
1880
1881         // Check whether the shortcuts are unique
1882         tomenu.checkShortcuts();
1883 }
1884
1885
1886 bool Menus::Impl::hasMenu(QString const & name) const
1887 {
1888         return find_if(menulist_.begin(), menulist_.end(),
1889                 MenuNamesEqual(name)) != menulist_.end();
1890 }
1891
1892
1893 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
1894 {
1895         const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
1896                 MenuNamesEqual(name));
1897         if (cit == menulist_.end())
1898                 LYXERR0("No submenu named " << name);
1899         LASSERT(cit != menulist_.end(), /**/);
1900         return (*cit);
1901 }
1902
1903
1904 MenuDefinition & Menus::Impl::getMenu(QString const & name)
1905 {
1906         iterator it = find_if(menulist_.begin(), menulist_.end(),
1907                 MenuNamesEqual(name));
1908         if (it == menulist_.end())
1909                 LYXERR0("No submenu named " << name);
1910         LASSERT(it != menulist_.end(), /**/);
1911         return (*it);
1912 }
1913
1914
1915 /////////////////////////////////////////////////////////////////////
1916 //
1917 // Menus
1918 //
1919 /////////////////////////////////////////////////////////////////////
1920
1921 Menus::Menus() : d(new Impl) {}
1922
1923
1924 Menus::~Menus()
1925 {
1926   delete d;
1927 }
1928
1929
1930 void Menus::reset()
1931 {
1932         delete d;
1933         d = new Impl;
1934 }
1935
1936
1937 void Menus::read(Lexer & lex)
1938 {
1939         enum {
1940                 md_menu,
1941                 md_menubar,
1942                 md_endmenuset
1943         };
1944
1945         LexerKeyword menutags[] = {
1946                 { "end", md_endmenuset },
1947                 { "menu", md_menu },
1948                 { "menubar", md_menubar }
1949         };
1950
1951         // consistency check
1952         if (compare_ascii_no_case(lex.getString(), "menuset"))
1953                 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
1954
1955         lex.pushTable(menutags);
1956         lex.setContext("Menus::read");
1957
1958         bool quit = false;
1959
1960         while (lex.isOK() && !quit) {
1961                 switch (lex.lex()) {
1962                 case md_menubar:
1963                         d->menubar_.read(lex);
1964                         break;
1965                 case md_menu: {
1966                         lex.next(true);
1967                         QString const name = toqstr(lex.getDocString());
1968                         if (d->hasMenu(name))
1969                                 d->getMenu(name).read(lex);
1970                         else {
1971                                 MenuDefinition menu(name);
1972                                 menu.read(lex);
1973                                 d->menulist_.push_back(menu);
1974                         }
1975                         break;
1976                 }
1977                 case md_endmenuset:
1978                         quit = true;
1979                         break;
1980                 default:
1981                         lex.printError("Unknown menu tag");
1982                         break;
1983                 }
1984         }
1985         lex.popTable();
1986 }
1987
1988
1989 bool Menus::searchMenu(FuncRequest const & func,
1990         docstring_list & names) const
1991 {
1992         MenuDefinition menu;
1993         d->expand(d->menubar_, menu, 0);
1994         return menu.searchMenu(func, names);
1995 }
1996
1997
1998 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
1999 {
2000         if (initial) {
2001 #ifdef Q_WS_MACX
2002                 // setup special mac specific menu items, but only do this
2003                 // the first time a QMenuBar is created. Otherwise Qt will
2004                 // create duplicate items in the application menu. It seems
2005                 // that Qt does not remove them when the QMenubar is cleared.
2006                 LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
2007                 d->macxMenuBarInit(view, qmb);
2008 #endif
2009         } else {
2010                 // Clear all menubar contents before filling it.
2011                 qmb->clear();
2012         }
2013
2014         LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
2015
2016         if (d->menubar_.size() == 0) {
2017                 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
2018                         << d->menubar_.name());
2019                 return;
2020         }
2021         LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
2022
2023         MenuDefinition menu;
2024         BufferView * bv = 0;
2025         if (view)
2026                 bv = view->currentBufferView();
2027         d->expand(d->menubar_, menu, bv);
2028
2029         MenuDefinition::const_iterator m = menu.begin();
2030         MenuDefinition::const_iterator end = menu.end();
2031
2032         for (; m != end; ++m) {
2033
2034                 if (m->kind() != MenuItem::Submenu) {
2035                         LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
2036                         continue;
2037                 }
2038
2039                 LYXERR(Debug::GUI, "menu bar item " << m->label()
2040                         << " is a submenu named " << m->submenuname());
2041
2042                 QString name = m->submenuname();
2043                 if (!d->hasMenu(name)) {
2044                         LYXERR(Debug::GUI, "\tERROR: " << name
2045                                 << " submenu has no menu!");
2046                         continue;
2047                 }
2048
2049                 Menu * menu = new Menu(view, m->submenuname(), true);
2050                 menu->setTitle(label(*m));
2051                 qmb->addMenu(menu);
2052
2053                 d->name_map_[view][name] = menu;
2054         }
2055 }
2056
2057
2058 void Menus::updateMenu(Menu * qmenu)
2059 {
2060         LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
2061         qmenu->clear();
2062
2063         if (qmenu->d->name.isEmpty())
2064                 return;
2065
2066         docstring identifier = qstring_to_ucs4(qmenu->d->name);
2067         MenuDefinition fromLyxMenu(qmenu->d->name);
2068         while (!identifier.empty()) {
2069                 docstring menu_name;
2070                 identifier = split(identifier, menu_name, ';');
2071
2072                 if (!d->hasMenu(toqstr(menu_name))) {
2073                         LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
2074                                 << menu_name);
2075                         continue;
2076                 }
2077
2078                 MenuDefinition cat_menu = d->getMenu(toqstr(menu_name));
2079                 //FIXME: 50 is a wild guess. We should take into account here
2080                 //the expansion of menu items, disabled optional items etc.
2081                 bool const in_sub_menu = fromLyxMenu.size() > 0
2082                         && fromLyxMenu.size() + cat_menu.size() > 50 ;
2083                 if (in_sub_menu)
2084                         fromLyxMenu.catSub(menu_name);
2085                 else
2086                         fromLyxMenu.cat(cat_menu);
2087                 fromLyxMenu.add(MenuItem(MenuItem::Separator));
2088         }
2089
2090         if (fromLyxMenu.empty()) {
2091                 qmenu->addAction(qt_("No Action Defined!"));
2092                 return;
2093         }
2094
2095         BufferView * bv = 0;
2096         if (qmenu->d->view)
2097                 bv = qmenu->d->view->currentBufferView();
2098         d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
2099         qmenu->d->populate(*qmenu, *qmenu->d->top_level_menu);
2100 }
2101
2102
2103 Menu * Menus::menu(QString const & name, GuiView & view, bool keyboard)
2104 {
2105         LYXERR(Debug::GUI, "Context menu requested: " << name);
2106         Menu * menu = d->name_map_[&view].value(name, 0);
2107         if (!menu && !name.startsWith("context-")) {
2108                 LYXERR0("requested context menu not found: " << name);
2109                 return 0;
2110         }
2111
2112         menu = new Menu(&view, name, true, keyboard);
2113         d->name_map_[&view][name] = menu;
2114         return menu;
2115 }
2116
2117 } // namespace frontend
2118 } // namespace lyx
2119
2120 #include "moc_Menus.cpp"