3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup
8 * \author Lars Gullik Bjønnes
9 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Martin Vermeer
14 * Full author contact details are available in file CREDITS.
22 #include "GuiApplication.h"
24 #include "GuiWorkArea.h"
25 #include "qt_helpers.h"
27 #include "BiblioInfo.h"
28 #include "BranchList.h"
30 #include "BufferList.h"
31 #include "BufferParams.h"
32 #include "BufferView.h"
33 #include "Converter.h"
34 #include "CutAndPaste.h"
36 #include "FloatList.h"
38 #include "FuncRequest.h"
39 #include "FuncStatus.h"
40 #include "IndicesList.h"
45 #include "LyXAction.h"
49 #include "Paragraph.h"
50 #include "ParagraphParameters.h"
51 #include "ParIterator.h"
53 #include "SpellChecker.h"
54 #include "TextClass.h"
56 #include "TocBackend.h"
58 #include "WordLangTuple.h"
60 #include "insets/Inset.h"
61 #include "insets/InsetCitation.h"
62 #include "insets/InsetGraphics.h"
64 #include "support/lassert.h"
65 #include "support/convert.h"
66 #include "support/debug.h"
67 #include "support/docstring_list.h"
68 #include "support/filetools.h"
69 #include "support/gettext.h"
70 #include "support/lstrings.h"
77 #if QT_VERSION >= 0x040600
78 #include <QProxyStyle>
81 #include "support/shared_ptr.h"
87 using namespace lyx::support;
95 // MacOSX specific stuff is at the end.
102 /// The type of elements that can be in a menu
110 /** This type of item explains why something is unavailable. If this
111 menuitem is in a submenu, the submenu is enabled to make sure the
112 user sees the information. */
114 /** This type of item merely shows that there might be a list or
115 something alike at this position, but the list is still empty.
116 If this item is in a submenu, the submenu will not always be
119 /** This is the list of last opened file,
120 typically for the File menu. */
122 /** This is the list of opened Documents,
123 typically for the Documents menu. */
125 /** This is the bookmarks */
129 /** This is a list of viewable formats
130 typically for the File->View menu. */
132 /** This is a list of updatable formats
133 typically for the File->Update menu. */
135 /** This is a list of exportable formats
136 typically for the File->Export menu. */
138 /** This is a list of importable formats
139 typically for the File->Import menu. */
141 /** This is the list of elements available
142 * for insertion into document. */
144 /** This is the list of user-configurable
145 insets to insert into document */
147 /** This is the list of XML elements to
148 insert into the document */
150 /** This is the list of floats that we can
151 insert a list for. */
153 /** This is the list of floats that we can
156 /** This is the list of selections that can
161 /** Available branches in document */
163 /** Available indices in document */
165 /** Context menu for indices in document */
167 /** Available index lists in document */
169 /** Context menu for available indices lists in document */
171 /** Available citation styles for a given citation */
173 /** Available graphics groups */
175 /// Words suggested by the spellchecker.
177 /** Used Languages */
179 /** This is the list of arguments available
180 for insertion into the current layout. */
182 /** This is the list of arguments available
183 in the InsetArgument context menu. */
185 /** This is the list of captions available
186 in the current layout. */
188 /** This is the list of captions available
189 in the InsetCaption context menu. */
191 /** Commands to separate environments. */
192 EnvironmentSeparators
195 explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
198 QString const & label,
199 QString const & submenu = QString(),
200 QString const & tooltip = QString(),
201 bool optional = false)
202 : kind_(kind), label_(label), submenuname_(submenu),
203 tooltip_(tooltip), optional_(optional)
205 LATTEST(kind == Submenu || kind == Help || kind == Info);
209 QString const & label,
210 FuncRequest const & func,
211 QString const & tooltip = QString(),
212 bool optional = false,
213 FuncRequest::Origin origin = FuncRequest::MENU)
214 : kind_(kind), label_(label), func_(func),
215 tooltip_(tooltip), optional_(optional)
217 func_.setOrigin(origin);
220 // shared_ptr<MenuDefinition> needs this apprently...
223 /// The label of a given menuitem
224 QString label() const
226 int const index = label_.lastIndexOf('|');
227 return index == -1 ? label_ : label_.left(index);
230 /// The keyboard shortcut (usually underlined in the entry)
231 QString shortcut() const
233 int const index = label_.lastIndexOf('|');
234 return index == -1 ? QString() : label_.mid(index + 1);
236 /// The complete label, with label and shortcut separated by a '|'
237 QString fulllabel() const { return label_; }
238 /// The kind of entry
239 Kind kind() const { return kind_; }
240 /// the action (if relevant)
241 FuncRequest const & func() const { return func_; }
243 QString const & tooltip() const { return tooltip_; }
244 /// returns true if the entry should be omitted when disabled
245 bool optional() const { return optional_; }
246 /// returns the status of the lfun associated with this entry
247 FuncStatus const & status() const { return status_; }
248 /// returns the status of the lfun associated with this entry
249 FuncStatus & status() { return status_; }
250 /// returns the status of the lfun associated with this entry
251 void status(FuncStatus const & status) { status_ = status; }
253 ///returns the binding associated to this action.
254 QString binding() const
256 if (kind_ != Command)
258 // Get the keys bound to this action, but keep only the
260 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
261 if (!bindings.empty())
262 return toqstr(bindings.begin()->print(KeySequence::ForGui));
264 LYXERR(Debug::KBMAP, "No binding for "
265 << lyxaction.getActionName(func_.action())
266 << '(' << func_.argument() << ')');
270 /// the description of the submenu (if relevant)
271 QString const & submenuname() const { return submenuname_; }
272 /// set the description of the submenu
273 void submenuname(QString const & name) { submenuname_ = name; }
275 bool hasSubmenu() const { return !submenu_.isEmpty(); }
277 MenuDefinition const & submenu() const { return submenu_.at(0); }
278 MenuDefinition & submenu() { return submenu_[0]; }
280 void setSubmenu(MenuDefinition const & menu)
283 submenu_.append(menu);
294 QString submenuname_;
301 /// contains 0 or 1 item.
302 QList<MenuDefinition> submenu_;
306 class MenuDefinition {
309 typedef std::vector<MenuItem> ItemList;
311 typedef ItemList::const_iterator const_iterator;
313 explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
318 QString const & name() const { return name_; }
320 bool empty() const { return items_.empty(); }
321 /// Clear the menu content.
322 void clear() { items_.clear(); }
324 size_t size() const { return items_.size(); }
326 MenuItem const & operator[](size_t) const;
328 const_iterator begin() const { return items_.begin(); }
330 const_iterator end() const { return items_.end(); }
332 void cat(MenuDefinition const & other);
334 void catSub(docstring const & name);
336 // search for func in this menu iteratively, and put menu
338 bool searchMenu(FuncRequest const & func, docstring_list & names)
341 bool hasFunc(FuncRequest const &) const;
342 /// Add the menu item unconditionally
343 void add(MenuItem const & item) { items_.push_back(item); }
344 /// Checks the associated FuncRequest status before adding the
346 void addWithStatusCheck(MenuItem const &);
347 // Check whether the menu shortcuts are unique
348 void checkShortcuts() const;
350 void expandLastfiles();
351 void expandDocuments();
352 void expandBookmarks();
353 void expandFormats(MenuItem::Kind const kind, Buffer const * buf);
354 void expandFloatListInsert(Buffer const * buf);
355 void expandFloatInsert(Buffer const * buf);
356 void expandFlexInsert(Buffer const * buf, InsetLayout::InsetLyXType type);
357 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth);
358 void expandToc(Buffer const * buf);
359 void expandPasteRecent(Buffer const * buf);
360 void expandToolbars();
361 void expandBranches(Buffer const * buf);
362 void expandIndices(Buffer const * buf, bool listof = false);
363 void expandIndicesContext(Buffer const * buf, bool listof = false);
364 void expandCiteStyles(BufferView const *);
365 void expandGraphicsGroups(BufferView const *);
366 void expandSpellingSuggestions(BufferView const *);
367 void expandLanguageSelector(Buffer const * buf);
368 void expandArguments(BufferView const *, bool switcharg = false);
369 void expandCaptions(Buffer const * buf, bool switchcap = false);
370 void expandEnvironmentSeparators(BufferView const *);
378 /// Helper for std::find_if
382 MenuNamesEqual(QString const & name) : name_(name) {}
383 bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
390 typedef std::vector<MenuDefinition> MenuList;
392 typedef MenuList::const_iterator const_iterator;
394 typedef MenuList::iterator iterator;
396 /////////////////////////////////////////////////////////////////////
397 // MenuDefinition implementation
398 /////////////////////////////////////////////////////////////////////
400 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
404 case MenuItem::Command: {
405 FuncStatus status = lyx::getStatus(i.func());
406 if (status.unknown() || (!status.enabled() && i.optional()))
409 items_.back().status(status);
413 case MenuItem::Submenu: {
414 bool enabled = false;
415 if (i.hasSubmenu()) {
416 for (const_iterator cit = i.submenu().begin();
417 cit != i.submenu().end(); ++cit) {
418 // Only these kind of items affect the status of the submenu
419 if ((cit->kind() == MenuItem::Command
420 || cit->kind() == MenuItem::Submenu
421 || cit->kind() == MenuItem::Help)) {
427 if (enabled || !i.optional()) {
429 items_.back().status().setEnabled(enabled);
434 case MenuItem::Separator:
435 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
445 void MenuDefinition::read(Lexer & lex)
462 md_indiceslistscontext,
476 md_spellingsuggestions,
485 LexerKeyword menutags[] = {
486 { "arguments", md_arguments },
487 { "bookmarks", md_bookmarks },
488 { "branches", md_branches },
489 { "captions", md_captions },
490 { "charstyles", md_charstyles },
491 { "citestyles", md_citestyles },
492 { "custom", md_custom },
493 { "documents", md_documents },
494 { "elements", md_elements },
495 { "end", md_endmenu },
496 { "environmentseparators", md_env_separators },
497 { "exportformats", md_exportformats },
498 { "floatinsert", md_floatinsert },
499 { "floatlistinsert", md_floatlistinsert },
500 { "graphicsgroups", md_graphicsgroups },
501 { "importformats", md_importformats },
502 { "indices", md_indices },
503 { "indicescontext", md_indicescontext },
504 { "indiceslists", md_indiceslists },
505 { "indiceslistscontext", md_indiceslistscontext },
507 { "languageselector", md_languageselector },
508 { "lastfiles", md_lastfiles },
509 { "optitem", md_optitem },
510 { "optsubmenu", md_optsubmenu },
511 { "pasterecent", md_pasterecent },
512 { "separator", md_separator },
513 { "spellingsuggestions", md_spellingsuggestions },
514 { "submenu", md_submenu },
515 { "switcharguments", md_switcharguments },
516 { "switchcaptions", md_switchcaptions },
518 { "toolbars", md_toolbars },
519 { "updateformats", md_updateformats },
520 { "viewformats", md_viewformats }
523 lex.pushTable(menutags);
524 lex.setContext("MenuDefinition::read: ");
527 while (lex.isOK() && md_type != md_endmenu) {
528 switch (md_type = lex.lex()) {
532 docstring const name = translateIfPossible(lex.getDocString());
534 string const command = lex.getString();
535 FuncRequest func = lyxaction.lookupFunc(command);
536 FuncRequest::Origin origin = FuncRequest::MENU;
537 if (name_.startsWith("context-toc-"))
538 origin = FuncRequest::TOC;
539 bool const optional = (md_type == md_optitem);
540 add(MenuItem(MenuItem::Command, toqstr(name), func, QString(), optional, origin));
545 add(MenuItem(MenuItem::Separator));
549 add(MenuItem(MenuItem::Lastfiles));
553 add(MenuItem(MenuItem::CharStyles));
557 add(MenuItem(MenuItem::Custom));
561 add(MenuItem(MenuItem::Elements));
565 add(MenuItem(MenuItem::Documents));
569 add(MenuItem(MenuItem::Bookmarks));
573 add(MenuItem(MenuItem::Toc));
577 add(MenuItem(MenuItem::ViewFormats));
580 case md_updateformats:
581 add(MenuItem(MenuItem::UpdateFormats));
584 case md_exportformats:
585 add(MenuItem(MenuItem::ExportFormats));
588 case md_importformats:
589 add(MenuItem(MenuItem::ImportFormats));
592 case md_floatlistinsert:
593 add(MenuItem(MenuItem::FloatListInsert));
597 add(MenuItem(MenuItem::FloatInsert));
601 add(MenuItem(MenuItem::PasteRecent));
605 add(MenuItem(MenuItem::Toolbars));
609 add(MenuItem(MenuItem::Branches));
613 add(MenuItem(MenuItem::CiteStyles));
616 case md_graphicsgroups:
617 add(MenuItem(MenuItem::GraphicsGroups));
620 case md_spellingsuggestions:
621 add(MenuItem(MenuItem::SpellingSuggestions));
624 case md_languageselector:
625 add(MenuItem(MenuItem::LanguageSelector));
629 add(MenuItem(MenuItem::Indices));
632 case md_indicescontext:
633 add(MenuItem(MenuItem::IndicesContext));
636 case md_indiceslists:
637 add(MenuItem(MenuItem::IndicesLists));
640 case md_indiceslistscontext:
641 add(MenuItem(MenuItem::IndicesListsContext));
645 add(MenuItem(MenuItem::Arguments));
648 case md_switcharguments:
649 add(MenuItem(MenuItem::SwitchArguments));
653 add(MenuItem(MenuItem::Captions));
656 case md_switchcaptions:
657 add(MenuItem(MenuItem::SwitchCaptions));
660 case md_env_separators:
661 add(MenuItem(MenuItem::EnvironmentSeparators));
667 docstring const mlabel = translateIfPossible(lex.getDocString());
669 docstring const mname = lex.getDocString();
670 bool const optional = (md_type == md_optsubmenu);
671 add(MenuItem(MenuItem::Submenu,
672 toqstr(mlabel), toqstr(mname), QString(), optional));
680 lex.printError("Unknown menu tag");
688 MenuItem const & MenuDefinition::operator[](size_type i) const
694 bool MenuDefinition::hasFunc(FuncRequest const & func) const
696 for (const_iterator it = begin(), et = end(); it != et; ++it)
697 if (it->func() == func)
703 void MenuDefinition::catSub(docstring const & name)
705 add(MenuItem(MenuItem::Submenu,
706 qt_("More...|M"), toqstr(name), QString(), false));
709 void MenuDefinition::cat(MenuDefinition const & other)
711 const_iterator et = other.end();
712 for (const_iterator it = other.begin(); it != et; ++it)
717 void MenuDefinition::checkShortcuts() const
719 // This is a quadratic algorithm, but we do not care because
720 // menus are short enough
721 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
722 QString shortcut = it1->shortcut();
723 if (shortcut.isEmpty())
725 if (!it1->label().contains(shortcut))
726 LYXERR0("Menu warning: menu entry \""
728 << "\" does not contain shortcut `"
729 << shortcut << "'.");
730 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
731 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
732 LYXERR0("Menu warning: menu entries "
733 << '"' << it1->fulllabel()
734 << "\" and \"" << it2->fulllabel()
735 << "\" share the same shortcut.");
742 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
744 const_iterator m = begin();
745 const_iterator m_end = end();
746 for (; m != m_end; ++m) {
747 if (m->kind() == MenuItem::Command && m->func() == func) {
748 names.push_back(qstring_to_ucs4(m->label()));
751 if (m->kind() == MenuItem::Submenu) {
752 names.push_back(qstring_to_ucs4(m->label()));
753 if (!m->hasSubmenu()) {
754 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
755 << m->label() << " name=" << m->submenuname());
759 if (m->submenu().searchMenu(func, names))
768 QString limitStringLength(docstring const & str)
770 size_t const max_item_length = 45;
772 if (str.size() > max_item_length)
773 return toqstr(str.substr(0, max_item_length - 3) + "...");
779 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
784 graphics::getGraphicsGroups(bv->buffer(), grp);
788 set<string>::const_iterator it = grp.begin();
789 set<string>::const_iterator end = grp.end();
790 add(MenuItem(MenuItem::Command, qt_("No Group"),
791 FuncRequest(LFUN_SET_GRAPHICS_GROUP)));
792 for (; it != end; ++it) {
793 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it) + '|',
794 FuncRequest(LFUN_SET_GRAPHICS_GROUP, *it)));
799 void MenuDefinition::expandSpellingSuggestions(BufferView const * bv)
803 Cursor const & cur = bv->cursor();
807 docstring_list suggestions;
808 Paragraph const & par = cur.paragraph();
809 pos_type from = cur.pos();
811 SpellChecker::Result res = par.spellCheck(from, to, wl, suggestions, true, true);
813 case SpellChecker::UNKNOWN_WORD:
814 if (lyxrc.spellcheck_continuously) {
815 LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
816 docstring const & selection = cur.selectionAsString(false);
817 if (!cur.selection() || selection == wl.word()) {
819 size_t m = 10; // first submenu index
820 MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
821 item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
822 for (; i != suggestions.size(); ++i) {
823 docstring const & suggestion = suggestions[i];
824 LYXERR(Debug::GUI, suggestion);
825 MenuItem w(MenuItem::Command, toqstr(suggestion),
826 FuncRequest(LFUN_WORD_REPLACE,
827 replace2string(suggestion, selection,
828 true, // case sensitive
832 false))); // find next
836 item.submenu().add(w);
841 add(MenuItem(MenuItem::Separator));
842 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
843 add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|n"),
844 FuncRequest(LFUN_SPELLING_ADD, arg)));
845 add(MenuItem(MenuItem::Command, qt_("Ignore all|I"),
846 FuncRequest(LFUN_SPELLING_IGNORE, arg)));
850 case SpellChecker::LEARNED_WORD: {
851 LYXERR(Debug::GUI, "Learned Word.");
852 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
853 add(MenuItem(MenuItem::Command, qt_("Remove from personal dictionary|r"),
854 FuncRequest(LFUN_SPELLING_REMOVE, arg)));
857 case SpellChecker::NO_DICTIONARY:
858 LYXERR(Debug::GUI, "No dictionary for language " + from_ascii(wl.lang()->lang()));
860 case SpellChecker::WORD_OK:
861 case SpellChecker::COMPOUND_WORD:
862 case SpellChecker::ROOT_FOUND:
863 case SpellChecker::IGNORED_WORD:
868 struct sortLanguageByName {
869 bool operator()(const Language * a, const Language * b) const {
870 return qt_(a->display()).localeAwareCompare(qt_(b->display())) < 0;
874 void MenuDefinition::expandLanguageSelector(Buffer const * buf)
879 std::set<Language const *> languages_buffer =
880 buf->masterBuffer()->getLanguages();
882 if (languages_buffer.size() < 2)
885 std::set<Language const *, sortLanguageByName> languages;
887 std::set<Language const *>::const_iterator const beg =
888 languages_buffer.begin();
889 for (std::set<Language const *>::const_iterator cit = beg;
890 cit != languages_buffer.end(); ++cit) {
891 languages.insert(*cit);
894 MenuItem item(MenuItem::Submenu, qt_("Language|L"));
895 item.setSubmenu(MenuDefinition(qt_("Language")));
896 QString morelangs = qt_("More Languages ...|M");
897 QStringList accelerators;
898 if (morelangs.contains('|'))
899 accelerators.append(morelangs.section('|', -1));
900 std::set<Language const *, sortLanguageByName>::const_iterator const begin = languages.begin();
901 for (std::set<Language const *, sortLanguageByName>::const_iterator cit = begin;
902 cit != languages.end(); ++cit) {
903 QString label = qt_((*cit)->display());
904 // try to add an accelerator
905 bool success = false;
906 // try capitals first
907 for (int i = 0; i < label.size(); ++i) {
908 QChar const ch = label[i];
911 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
912 label = label + toqstr("|") + ch;
913 accelerators.append(ch);
918 // if all capitals are taken, try the rest
920 for (int i = 0; i < label.size(); ++i) {
921 if (label[i].isSpace())
923 QString const ch = QString(label[i]);
924 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
925 label = label + toqstr("|") + ch;
926 accelerators.append(ch);
931 MenuItem w(MenuItem::Command, label,
932 FuncRequest(LFUN_LANGUAGE, (*cit)->lang() + " set"));
933 item.submenu().addWithStatusCheck(w);
935 item.submenu().add(MenuItem(MenuItem::Separator));
936 item.submenu().add(MenuItem(MenuItem::Command, morelangs,
937 FuncRequest(LFUN_DIALOG_SHOW, "character")));
942 void MenuDefinition::expandLastfiles()
944 LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
945 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
949 for (; lfit != lf.end() && ii <= lyxrc.num_lastfiles; ++lfit, ++ii) {
950 string const file = lfit->absFileName();
951 QString const short_path = toqstr(makeDisplayPath(file, 30));
952 QString const long_path = toqstr(makeDisplayPath(file));
955 label = QString("%1. %2|%3").arg(ii).arg(short_path).arg(ii);
957 label = QString("%1. %2").arg(ii).arg(short_path);
958 add(MenuItem(MenuItem::Command, label,
959 FuncRequest(LFUN_FILE_OPEN, file), long_path));
964 void MenuDefinition::expandDocuments()
966 MenuItem item(MenuItem::Submenu, qt_("Hidden|H"));
967 item.setSubmenu(MenuDefinition(qt_("Hidden|H")));
969 Buffer * first = theBufferList().first();
971 add(MenuItem(MenuItem::Info, qt_("<No Documents Open>")));
977 if (!guiApp->currentView())
979 GuiWorkArea * wa = guiApp->currentView()->workArea(i);
982 Buffer const & b = wa->bufferView().buffer();
983 QString label = toqstr(b.fileName().displayName(20));
987 label = QString::number(i) + ". " + label + '|' + QString::number(i);
988 add(MenuItem(MenuItem::Command, label,
989 FuncRequest(LFUN_BUFFER_SWITCH, b.absFileName())));
996 // We cannot use a for loop as the buffer list cycles.
998 if (!(guiApp->currentView()
999 && guiApp->currentView()->workArea(*b))) {
1000 QString label = toqstr(b->fileName().displayName(20));
1004 label = QString::number(i) + ". " + label + '|' + QString::number(i);
1005 item.submenu().add(MenuItem(MenuItem::Command, label,
1006 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
1009 b = theBufferList().next(b);
1010 } while (b != first);
1012 if (!item.submenu().empty())
1017 void MenuDefinition::expandBookmarks()
1019 lyx::BookmarksSection const & bm = theSession().bookmarks();
1022 for (size_t i = 1; i <= bm.size(); ++i) {
1023 if (bm.isValid(i)) {
1024 string const file = bm.bookmark(i).filename.absFileName();
1025 QString const label = QString("%1. %2|%3").arg(i)
1026 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
1027 add(MenuItem(MenuItem::Command, label,
1028 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
1033 add(MenuItem(MenuItem::Info, qt_("<No Bookmarks Saved Yet>")));
1037 void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf)
1039 if (!buf && kind != MenuItem::ImportFormats)
1042 typedef vector<Format const *> Formats;
1044 FuncCode action = LFUN_NOACTION;
1047 case MenuItem::ImportFormats:
1048 formats = theConverters().importableFormats();
1049 action = LFUN_BUFFER_IMPORT;
1051 case MenuItem::ViewFormats:
1052 formats = buf->params().exportableFormats(true);
1053 action = LFUN_BUFFER_VIEW;
1055 case MenuItem::UpdateFormats:
1056 formats = buf->params().exportableFormats(true);
1057 action = LFUN_BUFFER_UPDATE;
1059 case MenuItem::ExportFormats:
1060 formats = buf->params().exportableFormats(false);
1061 action = LFUN_BUFFER_EXPORT;
1067 sort(formats.begin(), formats.end(), Format::formatSorter);
1069 bool const view_update = (kind == MenuItem::ViewFormats
1070 || kind == MenuItem::UpdateFormats);
1074 smenue = (kind == MenuItem::ViewFormats
1075 ? qt_("View (Other Formats)|F")
1076 : qt_("Update (Other Formats)|p"));
1077 MenuItem item(MenuItem::Submenu, smenue);
1078 item.setSubmenu(MenuDefinition(smenue));
1080 Formats::const_iterator fit = formats.begin();
1081 Formats::const_iterator end = formats.end();
1082 for (; fit != end ; ++fit) {
1083 if ((*fit)->dummy())
1086 docstring lab = from_utf8((*fit)->prettyname());
1087 docstring const scut = from_utf8((*fit)->shortcut());
1088 docstring const tmplab = lab;
1091 lab += char_type('|') + scut;
1092 docstring const lab_i18n = translateIfPossible(lab);
1093 docstring const shortcut = split(lab_i18n, lab, '|');
1095 bool const untranslated = (lab == lab_i18n);
1096 docstring label = untranslated ? translateIfPossible(tmplab) : lab;
1099 case MenuItem::ImportFormats:
1100 label += from_ascii("...");
1102 case MenuItem::ViewFormats:
1103 case MenuItem::UpdateFormats:
1104 if ((*fit)->name() == buf->params().getDefaultOutputFormat()) {
1105 docstring lbl = (kind == MenuItem::ViewFormats
1106 ? bformat(_("View [%1$s]|V"), label)
1107 : bformat(_("Update [%1$s]|U"), label));
1108 add(MenuItem(MenuItem::Command, toqstr(lbl), FuncRequest(action)));
1112 case MenuItem::ExportFormats:
1113 if (!(*fit)->inExportMenu())
1117 // we already asserted earlier in this case
1121 if (!shortcut.empty())
1122 label += '|' + shortcut;
1125 // note that at this point, we know that buf is not null
1127 item.submenu().addWithStatusCheck(MenuItem(MenuItem::Command,
1128 toqstr(label), FuncRequest(action, (*fit)->name())));
1131 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1132 FuncRequest(action, (*fit)->name())));
1134 add(MenuItem(MenuItem::Command, toqstr(label),
1135 FuncRequest(action, (*fit)->name())));
1143 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
1148 FloatList const & floats = buf->params().documentClass().floats();
1149 FloatList::const_iterator cit = floats.begin();
1150 FloatList::const_iterator end = floats.end();
1152 for (; cit != end; ++cit) {
1153 if (!cit->second.usesFloatPkg()) {
1154 // Different floats could declare the same ListCommand. We only
1155 // want it on the list once, though.
1156 string const & list_cmd = cit->second.listCommand();
1157 if (list_cmd.empty())
1158 // we do not know how to generate such a list
1160 // This form of insert returns an iterator pointing to the newly
1161 // inserted element OR the existing element with that value, and
1162 // a bool indicating whether we inserted a new element. So we can
1163 // see if one is there and insert it if not all at once.
1164 pair<set<string>::iterator, bool> ret = seen.insert(list_cmd);
1168 string const & list_name = cit->second.listName();
1169 addWithStatusCheck(MenuItem(MenuItem::Command, qt_(list_name),
1170 FuncRequest(LFUN_FLOAT_LIST_INSERT, cit->second.floattype())));
1175 void MenuDefinition::expandFloatInsert(Buffer const * buf)
1180 FloatList const & floats = buf->params().documentClass().floats();
1181 FloatList::const_iterator cit = floats.begin();
1182 FloatList::const_iterator end = floats.end();
1183 for (; cit != end; ++cit) {
1185 QString const label = qt_(cit->second.name());
1186 addWithStatusCheck(MenuItem(MenuItem::Command, label,
1187 FuncRequest(LFUN_FLOAT_INSERT,
1188 cit->second.floattype())));
1193 void MenuDefinition::expandFlexInsert(
1194 Buffer const * buf, InsetLayout::InsetLyXType type)
1199 TextClass::InsetLayouts const & insetLayouts =
1200 buf->params().documentClass().insetLayouts();
1201 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
1202 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
1203 for (; cit != end; ++cit) {
1204 if (cit->second.lyxtype() == type) {
1205 if (!cit->second.obsoleted_by().empty())
1207 docstring label = cit->first;
1208 // we remove the "Flex:" prefix, if it is present
1209 if (prefixIs(label, from_ascii("Flex:")))
1210 label = label.substr(5);
1211 addWithStatusCheck(MenuItem(MenuItem::Command,
1212 toqstr(translateIfPossible(label)),
1213 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(label))));
1216 // FIXME This is a little clunky.
1217 if (items_.empty() && type == InsetLayout::CUSTOM && !buf->isReadonly())
1218 add(MenuItem(MenuItem::Help, qt_("No Custom Insets Defined!")));
1222 size_t const max_number_of_items = 25;
1224 void MenuDefinition::expandToc2(Toc const & toc_list,
1225 size_t from, size_t to, int depth)
1227 int shortcut_count = 0;
1229 // check whether depth is smaller than the smallest depth in toc.
1230 int min_depth = 1000;
1231 for (size_t i = from; i < to; ++i)
1232 min_depth = min(min_depth, toc_list[i].depth());
1233 if (min_depth > depth)
1236 if (to - from <= max_number_of_items) {
1237 for (size_t i = from; i < to; ++i) {
1238 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
1239 label += limitStringLength(toc_list[i].str());
1240 if (toc_list[i].depth() == depth) {
1242 if (shortcut_count < 9) {
1243 if (label.contains(QString::number(shortcut_count + 1)))
1244 label += QString::number(++shortcut_count);
1247 add(MenuItem(MenuItem::Command, label,
1248 FuncRequest(toc_list[i].action())));
1253 size_t new_pos = pos + 1;
1254 while (new_pos < to && toc_list[new_pos].depth() > depth)
1257 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
1258 label += limitStringLength(toc_list[pos].str());
1259 if (toc_list[pos].depth() == depth) {
1261 if (shortcut_count < 9) {
1262 if (label.contains(QString::number(shortcut_count + 1)))
1263 label += QString::number(++shortcut_count);
1266 if (new_pos == pos + 1) {
1267 add(MenuItem(MenuItem::Command,
1268 label, FuncRequest(toc_list[pos].action())));
1271 sub.expandToc2(toc_list, pos, new_pos, depth + 1);
1272 MenuItem item(MenuItem::Submenu, label);
1273 item.setSubmenu(sub);
1282 void MenuDefinition::expandToc(Buffer const * buf)
1284 // To make things very cleanly, we would have to pass buf to
1285 // all MenuItem constructors and to expandToc2. However, we
1286 // know that all the entries in a TOC will be have status_ ==
1287 // OK, so we avoid this unnecessary overhead (JMarc)
1290 add(MenuItem(MenuItem::Info, qt_("<No Document Open>")));
1294 // Add an entry for the master doc if this is a child doc
1295 Buffer const * const master = buf->masterBuffer();
1296 if (buf != master) {
1297 ParIterator const pit = par_iterator_begin(master->inset());
1298 string const arg = convert<string>(pit->id());
1299 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
1300 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
1303 MenuDefinition other_lists;
1305 FloatList const & floatlist = buf->params().documentClass().floats();
1306 TocList const & toc_list = buf->tocBackend().tocs();
1307 TocList::const_iterator cit = toc_list.begin();
1308 TocList::const_iterator end = toc_list.end();
1309 for (; cit != end; ++cit) {
1310 // Handle this later
1311 if (cit->first == "tableofcontents")
1314 MenuDefinition submenu;
1315 if (floatlist.typeExist(cit->first)) {
1316 TocIterator ccit = cit->second->begin();
1317 TocIterator eend = cit->second->end();
1318 for (; ccit != eend; ++ccit) {
1319 if (0 == ccit->depth()) {// omit subfloats
1320 submenu.add(MenuItem(MenuItem::Command,
1321 limitStringLength(ccit->str()) + '|',
1322 FuncRequest(ccit->action())));
1326 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
1327 submenu.add(MenuItem(MenuItem::Separator));
1328 submenu.add(MenuItem(MenuItem::Command, qt_("Open Navigator..."), f));
1329 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
1330 // deserves to be in the main menu.
1331 item.setSubmenu(submenu);
1334 if (cit->second->size() >= 30) {
1335 // FIXME: the behaviour of the interface should not change
1336 // arbitrarily. Each type should be audited to see if the list
1337 // can be optimised like for floats above.
1338 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
1339 submenu.add(MenuItem(MenuItem::Command, qt_("Open Navigator..."), f));
1341 TocIterator ccit = cit->second->begin();
1342 TocIterator eend = cit->second->end();
1343 for (; ccit != eend; ++ccit) {
1344 submenu.add(MenuItem(MenuItem::Command,
1345 limitStringLength(ccit->str()) + '|',
1346 FuncRequest(ccit->action())));
1350 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
1351 item.setSubmenu(submenu);
1352 if (cit->first == "child") {
1353 // deserves to be in the main menu.
1356 other_lists.add(item);
1359 if (!other_lists.empty()) {
1360 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
1361 item.setSubmenu(other_lists);
1365 // Handle normal TOC
1366 cit = toc_list.find("tableofcontents");
1368 LYXERR(Debug::GUI, "No table of contents.");
1370 if (!cit->second->empty())
1371 expandToc2(* cit->second, 0, cit->second->size(), 0);
1373 add(MenuItem(MenuItem::Info, qt_("<Empty Table of Contents>")));
1378 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1380 docstring_list const sel = cap::availableSelections(buf);
1382 docstring_list::const_iterator cit = sel.begin();
1383 docstring_list::const_iterator end = sel.end();
1385 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1386 add(MenuItem(MenuItem::Command, toqstr(*cit) + '|',
1387 FuncRequest(LFUN_PASTE, convert<string>(index))));
1392 void MenuDefinition::expandToolbars()
1394 MenuDefinition other_lists;
1395 // extracts the toolbars from the backend
1396 Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1397 Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1398 for (; cit != end; ++cit) {
1399 MenuItem const item(MenuItem::Command, toqstr(cit->gui_name),
1400 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1401 if (guiApp->toolbars().isMainToolbar(cit->name))
1404 other_lists.add(item);
1407 if (!other_lists.empty()) {
1408 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1409 item.setSubmenu(other_lists);
1415 void MenuDefinition::expandBranches(Buffer const * buf)
1417 if (!buf || buf->isReadonly())
1420 BufferParams const & master_params = buf->masterBuffer()->params();
1421 BufferParams const & params = buf->params();
1422 if (params.branchlist().empty() && master_params.branchlist().empty() ) {
1423 add(MenuItem(MenuItem::Help, qt_("No Branches Set for Document!")));
1427 BranchList::const_iterator cit = master_params.branchlist().begin();
1428 BranchList::const_iterator end = master_params.branchlist().end();
1430 for (int ii = 1; cit != end; ++cit, ++ii) {
1431 docstring label = cit->branch();
1433 label = convert<docstring>(ii) + ". " + label
1434 + char_type('|') + convert<docstring>(ii);
1436 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1437 FuncRequest(LFUN_BRANCH_INSERT,
1441 if (buf == buf->masterBuffer())
1444 MenuDefinition child_branches;
1446 BranchList::const_iterator ccit = params.branchlist().begin();
1447 BranchList::const_iterator cend = params.branchlist().end();
1449 for (int ii = 1; ccit != cend; ++ccit, ++ii) {
1450 docstring label = ccit->branch();
1452 label = convert<docstring>(ii) + ". " + label
1453 + char_type('|') + convert<docstring>(ii);
1455 label += char_type('|');
1456 child_branches.addWithStatusCheck(MenuItem(MenuItem::Command,
1458 FuncRequest(LFUN_BRANCH_INSERT,
1462 if (!child_branches.empty()) {
1463 MenuItem item(MenuItem::Submenu, qt_("Child Document"));
1464 item.setSubmenu(child_branches);
1470 void MenuDefinition::expandIndices(Buffer const * buf, bool listof)
1475 BufferParams const & params = buf->masterBuffer()->params();
1476 if (!params.use_indices) {
1478 addWithStatusCheck(MenuItem(MenuItem::Command,
1479 qt_("Index List|I"),
1480 FuncRequest(LFUN_INDEX_PRINT,
1481 from_ascii("idx"))));
1483 addWithStatusCheck(MenuItem(MenuItem::Command,
1484 qt_("Index Entry|d"),
1485 FuncRequest(LFUN_INDEX_INSERT,
1486 from_ascii("idx"))));
1490 if (params.indiceslist().empty())
1493 IndicesList::const_iterator cit = params.indiceslist().begin();
1494 IndicesList::const_iterator end = params.indiceslist().end();
1496 for (int ii = 1; cit != end; ++cit, ++ii) {
1498 docstring const label =
1499 bformat(_("Index: %1$s"), cit->index());
1500 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1501 FuncRequest(LFUN_INDEX_PRINT, cit->shortcut())));
1503 docstring const label =
1504 bformat(_("Index Entry (%1$s)"), cit->index());
1505 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1506 FuncRequest(LFUN_INDEX_INSERT, cit->shortcut())));
1512 void MenuDefinition::expandIndicesContext(Buffer const * buf, bool listof)
1517 BufferParams const & params = buf->masterBuffer()->params();
1518 if (!params.use_indices || params.indiceslist().empty())
1521 IndicesList::const_iterator cit = params.indiceslist().begin();
1522 IndicesList::const_iterator end = params.indiceslist().end();
1524 for (int ii = 1; cit != end; ++cit, ++ii) {
1526 InsetCommandParams p(INDEX_PRINT_CODE);
1527 p["type"] = cit->shortcut();
1528 string const data = InsetCommand::params2string(p);
1529 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
1530 FuncRequest(LFUN_INSET_MODIFY, data)));
1532 docstring const label =
1533 bformat(_("Index Entry (%1$s)"), cit->index());
1534 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1535 FuncRequest(LFUN_INSET_MODIFY,
1536 from_ascii("changetype ") + cit->shortcut())));
1542 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1547 Inset const * inset = bv->cursor().nextInset();
1548 if (!inset || inset->lyxCode() != CITE_CODE) {
1549 add(MenuItem(MenuItem::Command,
1550 qt_("No Citation in Scope!"),
1551 FuncRequest(LFUN_NOACTION)));
1554 InsetCommand const * citinset =
1555 static_cast<InsetCommand const *>(inset);
1557 Buffer const * buf = &bv->buffer();
1558 string const cmd = citinset->params().getCmdName();
1560 docstring const & key = citinset->getParam("key");
1562 add(MenuItem(MenuItem::Command,
1563 qt_("No citations selected!"),
1564 FuncRequest(LFUN_NOACTION)));
1568 docstring const & before = citinset->getParam("before");
1569 docstring const & after = citinset->getParam("after");
1571 size_t const n = cmd.size();
1572 bool const force = cmd[0] == 'C';
1573 bool const full = cmd[n] == '*';
1575 vector<docstring> const keys = getVectorFromString(key);
1577 vector<CitationStyle> const citeStyleList = buf->params().citeStyles();
1578 static const size_t max_length = 40;
1579 vector<docstring> citeStrings =
1580 buf->masterBibInfo().getCiteStrings(keys, citeStyleList, bv->buffer(),
1581 before, after, from_utf8("dialog"), max_length);
1583 vector<docstring>::const_iterator cit = citeStrings.begin();
1584 vector<docstring>::const_iterator end = citeStrings.end();
1586 for (int ii = 1; cit != end; ++cit, ++ii) {
1587 docstring label = *cit;
1588 CitationStyle cs = citeStyleList[ii - 1];
1589 cs.forceUpperCase &= force;
1590 cs.fullAuthorList &= full;
1591 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1592 FuncRequest(LFUN_INSET_MODIFY,
1593 "changetype " + from_utf8(citationStyleToString(cs)))));
1598 void MenuDefinition::expandArguments(BufferView const * bv, bool switcharg)
1603 if (!bv->cursor().inTexted())
1606 Inset const * inset = &bv->cursor().inset();
1607 Layout::LaTeXArgMap args = bv->cursor().paragraph().layout().args();
1608 if (inset && args.empty())
1609 args = inset->getLayout().args();
1610 if (args.empty() || (switcharg && args.size() == 1))
1612 Layout::LaTeXArgMap::const_iterator lait = args.begin();
1613 Layout::LaTeXArgMap::const_iterator const laend = args.end();
1614 for (; lait != laend; ++lait) {
1615 Layout::latexarg arg = (*lait).second;
1616 docstring str = arg.menustring.empty()? arg.labelstring : arg.menustring;
1617 QString item = toqstr(translateIfPossible(str));
1619 add(MenuItem(MenuItem::Command, item,
1620 FuncRequest(LFUN_INSET_MODIFY,
1621 from_ascii("changetype ")
1622 + from_ascii((*lait).first))));
1624 add(MenuItem(MenuItem::Command, item,
1625 FuncRequest(LFUN_ARGUMENT_INSERT,
1626 from_ascii((*lait).first))));
1631 void MenuDefinition::expandCaptions(Buffer const * buf, bool switchcap)
1636 vector<docstring> caps;
1637 DocumentClass const & dc = buf->params().documentClass();
1638 TextClass::InsetLayouts::const_iterator lit = dc.insetLayouts().begin();
1639 TextClass::InsetLayouts::const_iterator len = dc.insetLayouts().end();
1640 for (; lit != len; ++lit) {
1641 if (prefixIs(lit->first, from_ascii("Caption:")))
1642 caps.push_back(lit->first);
1645 if (caps.empty() || (switchcap && caps.size() == 1))
1647 if (caps.size() == 1) {
1649 docstring const type = split(*caps.begin(), dummy, ':');
1650 add(MenuItem(MenuItem::Command, qt_("Caption"),
1651 FuncRequest(LFUN_CAPTION_INSERT, translateIfPossible(type))));
1655 MenuDefinition captions;
1657 vector<docstring>::const_iterator cit = caps.begin();
1658 vector<docstring>::const_iterator end = caps.end();
1660 for (int ii = 1; cit != end; ++cit, ++ii) {
1662 docstring const type = split(*cit, dummy, ':');
1663 docstring const trtype = translateIfPossible(type);
1664 docstring const cmitem = bformat(_("Caption (%1$s)"), trtype);
1665 // make menu item optional, otherwise we would also see
1666 // forbidden caption types
1668 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cmitem),
1669 FuncRequest(LFUN_INSET_MODIFY,
1670 from_ascii("changetype ")
1671 + type), QString(), true));
1673 captions.addWithStatusCheck(MenuItem(MenuItem::Command,
1675 FuncRequest(LFUN_CAPTION_INSERT,
1676 type), QString(), true));
1678 if (!captions.empty()) {
1679 MenuItem item(MenuItem::Submenu, qt_("Caption"));
1680 item.setSubmenu(captions);
1686 void MenuDefinition::expandEnvironmentSeparators(BufferView const * bv)
1690 Text const * text = bv->cursor().text();
1691 // no paragraphs and no separators exist in math
1695 pit_type pit = bv->cursor().selBegin().pit();
1696 Paragraph const & par = text->getPar(pit);
1697 docstring const curlayout = par.layout().name();
1698 docstring outerlayout;
1699 depth_type current_depth = par.params().depth();
1700 // check if we have an environment in our nesting hierarchy
1701 Paragraph cpar = par;
1703 if (pit == 0 || cpar.params().depth() == 0)
1706 cpar = text->getPar(pit);
1707 if (cpar.params().depth() < current_depth
1708 && cpar.layout().isEnvironment()) {
1709 outerlayout = cpar.layout().name();
1710 current_depth = cpar.params().depth();
1713 if (par.layout().isEnvironment()) {
1714 docstring const label =
1715 bformat(_("Start New Environment (%1$s)"),
1716 translateIfPossible(curlayout));
1717 add(MenuItem(MenuItem::Command, toqstr(label),
1718 FuncRequest(LFUN_ENVIRONMENT_SPLIT)));
1720 if (!outerlayout.empty()) {
1721 docstring const label =
1722 bformat(_("Start New Parent Environment (%1$s)"),
1723 translateIfPossible(outerlayout));
1724 add(MenuItem(MenuItem::Command, toqstr(label),
1725 FuncRequest(LFUN_ENVIRONMENT_SPLIT,
1726 from_ascii("outer"))));
1733 /////////////////////////////////////////////////////////////////////
1734 // Menu::Impl definition and implementation
1735 /////////////////////////////////////////////////////////////////////
1739 /// populates the menu or one of its submenu
1740 /// This is used as a recursive function
1741 void populate(QMenu & qMenu, MenuDefinition const & menu);
1743 /// Only needed for top level menus.
1744 MenuDefinition * top_level_menu;
1747 /// the name of this menu
1753 /// Get a MenuDefinition item label from the menu backend
1754 static QString label(MenuItem const & mi)
1756 QString label = mi.label();
1757 label.replace("&", "&&");
1759 QString shortcut = mi.shortcut();
1760 if (!shortcut.isEmpty()) {
1761 int pos = label.indexOf(shortcut);
1763 //label.insert(pos, 1, char_type('&'));
1764 label.replace(pos, 0, "&");
1767 QString const binding = mi.binding();
1768 if (!binding.isEmpty())
1769 label += '\t' + binding;
1774 void Menu::Impl::populate(QMenu & qMenu, MenuDefinition const & menu)
1776 LYXERR(Debug::GUI, "populating menu " << menu.name());
1778 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
1781 LYXERR(Debug::GUI, " ***** menu entries " << menu.size());
1782 MenuDefinition::const_iterator m = menu.begin();
1783 MenuDefinition::const_iterator end = menu.end();
1784 for (; m != end; ++m) {
1785 if (m->kind() == MenuItem::Separator)
1786 qMenu.addSeparator();
1787 else if (m->kind() == MenuItem::Submenu) {
1788 QMenu * subMenu = qMenu.addMenu(label(*m));
1789 populate(*subMenu, m->submenu());
1790 subMenu->setEnabled(m->status().enabled());
1792 // we have a MenuItem::Command
1793 qMenu.addAction(new Action(QIcon(), label(*m),
1794 m->func(), m->tooltip(), &qMenu));
1799 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
1800 class AlwaysMnemonicStyle : public QProxyStyle {
1802 int styleHint(StyleHint hint, const QStyleOption *opt = 0, const QWidget *widget = 0,
1803 QStyleHintReturn *returnData = 0) const
1805 if (hint == QStyle::SH_UnderlineShortcut)
1807 return QProxyStyle::styleHint(hint, opt, widget, returnData);
1812 /////////////////////////////////////////////////////////////////////
1813 // Menu implementation
1814 /////////////////////////////////////////////////////////////////////
1816 Menu::Menu(GuiView * gv, QString const & name, bool top_level, bool keyboard)
1817 : QMenu(gv), d(new Menu::Impl)
1819 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
1821 setStyle(new AlwaysMnemonicStyle);
1825 d->top_level_menu = top_level? new MenuDefinition : 0;
1829 if (d->top_level_menu)
1830 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1836 delete d->top_level_menu;
1841 void Menu::updateView()
1843 guiApp->menus().updateMenu(this);
1849 QList<QAction *> items = actions();
1850 for (int i = 0; i != items.size(); ++i) {
1851 // QAction::menu() returns 0 if there's no submenu.
1852 delete items.at(i)->menu();
1858 /////////////////////////////////////////////////////////////////////
1859 // Menus::Impl definition and implementation
1860 /////////////////////////////////////////////////////////////////////
1862 struct Menus::Impl {
1864 bool hasMenu(QString const &) const;
1866 MenuDefinition & getMenu(QString const &);
1868 MenuDefinition const & getMenu(QString const &) const;
1870 /// Expands some special entries of the menu
1871 /** The entries with the following kind are expanded to a
1872 sequence of Command MenuItems: Lastfiles, Documents,
1873 ViewFormats, ExportFormats, UpdateFormats, Branches,
1874 Indices, Arguments, SwitchArguments, Captions, SwitchCaptions,
1875 EnvironmentSeparators
1877 void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1878 BufferView const *) const;
1880 /// Initialize specific MACOS X menubar
1881 void macxMenuBarInit(QMenuBar * qmb);
1883 /// Mac special menu.
1884 /** This defines a menu whose entries list the FuncRequests
1885 that will be removed by expand() in other menus. This is
1886 used by the Qt/Mac code.
1888 NOTE: Qt does not remove the menu items when clearing a QMenuBar,
1889 such that the items will keep accessing the FuncRequests in
1890 the MenuDefinition. While Menus::Impl might be recreated,
1891 we keep mac_special_menu_ in memory by making it static.
1893 static MenuDefinition mac_special_menu_;
1898 MenuDefinition menubar_;
1900 typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
1902 /// name to menu for \c menu() method.
1907 MenuDefinition Menus::Impl::mac_special_menu_;
1911 Here is what the Qt documentation says about how a menubar is chosen:
1913 1) If the window has a QMenuBar then it is used. 2) If the window
1914 is a modal then its menubar is used. If no menubar is specified
1915 then a default menubar is used (as documented below) 3) If the
1916 window has no parent then the default menubar is used (as
1919 The above 3 steps are applied all the way up the parent window
1920 chain until one of the above are satisifed. If all else fails a
1921 default menubar will be created, the default menubar on Qt/Mac is
1922 an empty menubar, however you can create a different default
1923 menubar by creating a parentless QMenuBar, the first one created
1924 will thus be designated the default menubar, and will be used
1925 whenever a default menubar is needed.
1927 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1928 that this menubar will be used also when one of LyX' dialogs has
1931 void Menus::Impl::macxMenuBarInit(QMenuBar * qmb)
1933 /* Since Qt 4.2, the qt/mac menu code has special code for
1934 specifying the role of a menu entry. However, it does not
1935 work very well with our scheme of creating menus on demand,
1936 and therefore we need to put these entries in a special
1937 invisible menu. (JMarc)
1940 /* The entries of our special mac menu. If we add support for
1941 * special entries in Menus, we could imagine something
1943 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
1944 * and therefore avoid hardcoding. I am not sure it is worth
1945 * the hassle, though. (JMarc)
1947 struct MacMenuEntry {
1951 QAction::MenuRole role;
1954 static MacMenuEntry entries[] = {
1955 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1956 QAction::AboutRole},
1957 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1958 QAction::PreferencesRole},
1959 #if !(defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
1960 /* This doesn't work with Cocoa. */
1961 {LFUN_RECONFIGURE, "", "Reconfigure",
1962 QAction::ApplicationSpecificRole},
1964 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1966 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1967 const bool first_call = mac_special_menu_.empty();
1969 LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
1970 // the special menu for Menus. Fill it up only once.
1972 for (size_t i = 0 ; i < num_entries ; ++i) {
1973 FuncRequest const func(entries[i].action,
1974 from_utf8(entries[i].arg));
1975 mac_special_menu_.add(MenuItem(MenuItem::Command,
1976 entries[i].label, func));
1980 // add the entries to a QMenu that will eventually be empty
1981 // and therefore invisible.
1982 QMenu * qMenu = qmb->addMenu("special");
1983 MenuDefinition::const_iterator cit = mac_special_menu_.begin();
1984 MenuDefinition::const_iterator end = mac_special_menu_.end();
1985 for (size_t i = 0 ; cit != end ; ++cit, ++i) {
1986 Action * action = new Action(QIcon(), cit->label(),
1987 cit->func(), QString(), qMenu);
1988 action->setMenuRole(entries[i].role);
1989 qMenu->addAction(action);
1994 void Menus::Impl::expand(MenuDefinition const & frommenu,
1995 MenuDefinition & tomenu, BufferView const * bv) const
1997 if (!tomenu.empty())
2000 for (MenuDefinition::const_iterator cit = frommenu.begin();
2001 cit != frommenu.end() ; ++cit) {
2002 Buffer const * buf = bv ? &bv->buffer() : 0;
2003 switch (cit->kind()) {
2004 case MenuItem::Lastfiles:
2005 tomenu.expandLastfiles();
2008 case MenuItem::Documents:
2009 tomenu.expandDocuments();
2012 case MenuItem::Bookmarks:
2013 tomenu.expandBookmarks();
2016 case MenuItem::ImportFormats:
2017 case MenuItem::ViewFormats:
2018 case MenuItem::UpdateFormats:
2019 case MenuItem::ExportFormats:
2020 tomenu.expandFormats(cit->kind(), buf);
2023 case MenuItem::CharStyles:
2024 tomenu.expandFlexInsert(buf, InsetLayout::CHARSTYLE);
2027 case MenuItem::Custom:
2028 tomenu.expandFlexInsert(buf, InsetLayout::CUSTOM);
2031 case MenuItem::Elements:
2032 tomenu.expandFlexInsert(buf, InsetLayout::ELEMENT);
2035 case MenuItem::FloatListInsert:
2036 tomenu.expandFloatListInsert(buf);
2039 case MenuItem::FloatInsert:
2040 tomenu.expandFloatInsert(buf);
2043 case MenuItem::PasteRecent:
2044 tomenu.expandPasteRecent(buf);
2047 case MenuItem::Toolbars:
2048 tomenu.expandToolbars();
2051 case MenuItem::Branches:
2052 tomenu.expandBranches(buf);
2055 case MenuItem::Indices:
2056 tomenu.expandIndices(buf);
2059 case MenuItem::IndicesContext:
2060 tomenu.expandIndicesContext(buf);
2063 case MenuItem::IndicesLists:
2064 tomenu.expandIndices(buf, true);
2067 case MenuItem::IndicesListsContext:
2068 tomenu.expandIndicesContext(buf, true);
2071 case MenuItem::CiteStyles:
2072 tomenu.expandCiteStyles(bv);
2076 tomenu.expandToc(buf);
2079 case MenuItem::GraphicsGroups:
2080 tomenu.expandGraphicsGroups(bv);
2083 case MenuItem::SpellingSuggestions:
2084 tomenu.expandSpellingSuggestions(bv);
2087 case MenuItem::LanguageSelector:
2088 tomenu.expandLanguageSelector(buf);
2091 case MenuItem::Arguments:
2092 tomenu.expandArguments(bv, false);
2095 case MenuItem::SwitchArguments:
2096 tomenu.expandArguments(bv, true);
2099 case MenuItem::Captions:
2100 tomenu.expandCaptions(buf, false);
2103 case MenuItem::SwitchCaptions:
2104 tomenu.expandCaptions(buf, true);
2107 case MenuItem::EnvironmentSeparators:
2108 tomenu.expandEnvironmentSeparators(bv);
2111 case MenuItem::Submenu: {
2112 MenuItem item(*cit);
2113 item.setSubmenu(MenuDefinition(cit->submenuname()));
2114 expand(getMenu(cit->submenuname()), item.submenu(), bv);
2115 tomenu.addWithStatusCheck(item);
2119 case MenuItem::Info:
2120 case MenuItem::Help:
2121 case MenuItem::Separator:
2122 tomenu.addWithStatusCheck(*cit);
2125 case MenuItem::Command:
2126 if (!mac_special_menu_.hasFunc(cit->func()))
2127 tomenu.addWithStatusCheck(*cit);
2131 // we do not want the menu to end with a separator
2132 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
2133 tomenu.items_.pop_back();
2135 // Check whether the shortcuts are unique
2136 tomenu.checkShortcuts();
2140 bool Menus::Impl::hasMenu(QString const & name) const
2142 return find_if(menulist_.begin(), menulist_.end(),
2143 MenuNamesEqual(name)) != menulist_.end();
2147 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
2149 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
2150 MenuNamesEqual(name));
2151 if (cit == menulist_.end()) {
2152 LYXERR0("No submenu named " << name);
2153 LASSERT(false, { static const MenuDefinition m; return m; });
2159 MenuDefinition & Menus::Impl::getMenu(QString const & name)
2161 iterator it = find_if(menulist_.begin(), menulist_.end(),
2162 MenuNamesEqual(name));
2163 if (it == menulist_.end()) {
2164 LYXERR0("No submenu named " << name);
2165 LASSERT(false, { static MenuDefinition m; return m; });
2171 /////////////////////////////////////////////////////////////////////
2175 /////////////////////////////////////////////////////////////////////
2177 Menus::Menus() : d(new Impl) {}
2193 void Menus::read(Lexer & lex)
2201 LexerKeyword menutags[] = {
2202 { "end", md_endmenuset },
2203 { "menu", md_menu },
2204 { "menubar", md_menubar }
2207 // consistency check
2208 if (compare_ascii_no_case(lex.getString(), "menuset"))
2209 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
2211 lex.pushTable(menutags);
2212 lex.setContext("Menus::read");
2216 while (lex.isOK() && !quit) {
2217 switch (lex.lex()) {
2219 d->menubar_.read(lex);
2223 QString const name = toqstr(lex.getDocString());
2224 if (d->hasMenu(name))
2225 d->getMenu(name).read(lex);
2227 MenuDefinition menu(name);
2229 d->menulist_.push_back(menu);
2237 lex.printError("Unknown menu tag");
2245 bool Menus::searchMenu(FuncRequest const & func,
2246 docstring_list & names) const
2248 MenuDefinition menu;
2249 d->expand(d->menubar_, menu, 0);
2250 return menu.searchMenu(func, names);
2254 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
2258 // setup special mac specific menu items, but only do this
2259 // the first time a QMenuBar is created. Otherwise Qt will
2260 // create duplicate items in the application menu. It seems
2261 // that Qt does not remove them when the QMenubar is cleared.
2262 d->macxMenuBarInit(qmb);
2265 // Clear all menubar contents before filling it.
2267 #if (QT_VERSION >= 0x050000 && defined(Q_OS_MAC))
2268 d->macxMenuBarInit(qmb);
2272 LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
2274 if (d->menubar_.empty()) {
2275 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
2276 << d->menubar_.name());
2279 LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
2281 MenuDefinition menu;
2282 BufferView * bv = 0;
2284 bv = view->currentBufferView();
2285 d->expand(d->menubar_, menu, bv);
2287 MenuDefinition::const_iterator m = menu.begin();
2288 MenuDefinition::const_iterator end = menu.end();
2290 for (; m != end; ++m) {
2292 if (m->kind() != MenuItem::Submenu) {
2293 LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
2297 LYXERR(Debug::GUI, "menu bar item " << m->label()
2298 << " is a submenu named " << m->submenuname());
2300 QString name = m->submenuname();
2301 if (!d->hasMenu(name)) {
2302 LYXERR(Debug::GUI, "\tERROR: " << name
2303 << " submenu has no menu!");
2307 Menu * menu = new Menu(view, m->submenuname(), true);
2308 menu->setTitle(label(*m));
2310 #if defined(Q_OS_MAC) && (defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
2311 // On Mac OS with QT/cocoa, the menu is not displayed if there is no action
2312 // so we create a temporary one here
2313 QAction * action = new QAction(menu);
2314 menu->addAction(action);
2319 d->name_map_[view][name] = menu;
2324 void Menus::updateMenu(Menu * qmenu)
2326 LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
2329 if (qmenu->d->name.isEmpty())
2332 docstring identifier = qstring_to_ucs4(qmenu->d->name);
2333 MenuDefinition fromLyxMenu(qmenu->d->name);
2334 while (!identifier.empty()) {
2335 docstring menu_name;
2336 identifier = split(identifier, menu_name, ';');
2338 if (!d->hasMenu(toqstr(menu_name))) {
2339 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
2344 MenuDefinition cat_menu = d->getMenu(toqstr(menu_name));
2345 //FIXME: 50 is a wild guess. We should take into account here
2346 //the expansion of menu items, disabled optional items etc.
2347 bool const in_sub_menu = !fromLyxMenu.empty()
2348 && fromLyxMenu.size() + cat_menu.size() > 50 ;
2350 fromLyxMenu.catSub(menu_name);
2352 fromLyxMenu.cat(cat_menu);
2353 fromLyxMenu.add(MenuItem(MenuItem::Separator));
2356 if (fromLyxMenu.empty()) {
2357 qmenu->addAction(qt_("No Action Defined!"));
2361 BufferView * bv = 0;
2363 bv = qmenu->d->view->currentBufferView();
2364 d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
2365 qmenu->d->populate(*qmenu, *qmenu->d->top_level_menu);
2369 Menu * Menus::menu(QString const & name, GuiView & view, bool keyboard)
2371 LYXERR(Debug::GUI, "Context menu requested: " << name);
2372 Menu * menu = d->name_map_[&view].value(name, 0);
2373 if (!menu && !name.startsWith("context-")) {
2374 LYXERR0("requested context menu not found: " << name);
2378 menu = new Menu(&view, name, true, keyboard);
2379 d->name_map_[&view][name] = menu;
2383 } // namespace frontend
2386 #include "moc_Menus.cpp"