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"
35 #include "CutAndPaste.h"
37 #include "FloatList.h"
39 #include "FuncRequest.h"
40 #include "FuncStatus.h"
41 #include "IndicesList.h"
46 #include "LyXAction.h"
50 #include "Paragraph.h"
51 #include "ParagraphParameters.h"
52 #include "ParIterator.h"
54 #include "SpellChecker.h"
55 #include "TextClass.h"
57 #include "TocBackend.h"
59 #include "WordLangTuple.h"
61 #include "insets/Inset.h"
62 #include "insets/InsetCitation.h"
63 #include "insets/InsetGraphics.h"
64 #include "insets/InsetInfo.h"
65 #include "insets/InsetQuotes.h"
67 #include "support/lassert.h"
68 #include "support/convert.h"
69 #include "support/debug.h"
70 #include "support/docstring_list.h"
71 #include "support/filetools.h"
72 #include "support/gettext.h"
73 #include "support/lstrings.h"
80 #if QT_VERSION >= 0x040600
81 #include <QProxyStyle>
89 using namespace lyx::support;
97 // MacOSX specific stuff is at the end.
104 /// The type of elements that can be in a menu
112 /** This type of item explains why something is unavailable. If this
113 menuitem is in a submenu, the submenu is enabled to make sure the
114 user sees the information. */
116 /** This type of item merely shows that there might be a list or
117 something alike at this position, but the list is still empty.
118 If this item is in a submenu, the submenu will not always be
121 /** This is the list of last opened file,
122 typically for the File menu. */
124 /** This is the list of opened Documents,
125 typically for the Documents menu. */
127 /** This is the bookmarks */
131 /** This is a list of viewable formats
132 typically for the File->View menu. */
134 /** This is a list of updatable formats
135 typically for the File->Update menu. */
137 /** This is a list of exportable formats
138 typically for the File->Export menu. */
140 /** This exports the document default format
141 typically for the File->Export menu. */
143 /** This is a list of importable formats
144 typically for the File->Import menu. */
146 /** This is the list of elements available
147 * for insertion into document. */
149 /** This is the list of user-configurable
150 insets to insert into document */
152 /** This is the list of floats that we can
153 insert a list for. */
155 /** This is the list of floats that we can
158 /** This is the list of selections that can
163 /** Available branches in document */
165 /** Available indices in document */
167 /** Context menu for indices in document */
169 /** Available index lists in document */
171 /** Context menu for available indices lists in document */
173 /** Available citation styles for a given citation */
175 /** Available arguments for a given info inset */
177 /** Available graphics groups */
179 /// Words suggested by the spellchecker.
181 /** Used Languages */
183 /** This is the list of arguments available
184 for insertion into the current layout. */
186 /** This is the list of arguments available
187 in the InsetArgument context menu. */
189 /** This is the list of captions available
190 in the current layout. */
192 /** This is the list of captions available
193 in the InsetCaption context menu. */
195 /** Commands to separate environments. */
196 EnvironmentSeparators,
197 /** Commands to separate environments (context menu version). */
198 EnvironmentSeparatorsContext,
199 /** This is the list of quotation marks available */
201 /** Options in the Zoom menu **/
205 explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
208 QString const & label,
209 QString const & submenu = QString(),
210 QString const & tooltip = QString(),
211 bool optional = false)
212 : kind_(kind), label_(label), func_(make_shared<FuncRequest>()),
213 submenuname_(submenu), tooltip_(tooltip), optional_(optional)
215 LATTEST(kind == Submenu || kind == Help || kind == Info);
219 QString const & label,
220 FuncRequest const & func,
221 QString const & tooltip = QString(),
222 bool optional = false,
223 FuncRequest::Origin origin = FuncRequest::MENU)
224 : kind_(kind), label_(label), func_(make_shared<FuncRequest>(func)),
225 tooltip_(tooltip), optional_(optional)
227 func_->setOrigin(origin);
230 /// The label of a given menuitem
231 QString label() const
233 int const index = label_.lastIndexOf('|');
234 return index == -1 ? label_ : label_.left(index);
237 /// The keyboard shortcut (usually underlined in the entry)
238 QString shortcut() const
240 int const index = label_.lastIndexOf('|');
241 return index == -1 ? QString() : label_.mid(index + 1);
243 /// The complete label, with label and shortcut separated by a '|'
244 QString fulllabel() const { return label_; }
245 /// The kind of entry
246 Kind kind() const { return kind_; }
247 /// the action (if relevant)
248 shared_ptr<FuncRequest const> func() const { return func_; }
250 QString const & tooltip() const { return tooltip_; }
251 /// returns true if the entry should be omitted when disabled
252 bool optional() const { return optional_; }
253 /// returns the status of the lfun associated with this entry
254 FuncStatus const & status() const { return status_; }
255 /// returns the status of the lfun associated with this entry
256 FuncStatus & status() { return status_; }
257 /// returns the status of the lfun associated with this entry
258 void status(FuncStatus const & status) { status_ = status; }
260 ///returns the binding associated to this action.
261 QString binding() const
263 if (kind_ != Command)
265 // Get the keys bound to this action, but keep only the
267 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(*func_);
268 if (!bindings.empty())
269 return toqstr(bindings.begin()->print(KeySequence::ForGui));
271 LYXERR(Debug::KBMAP, "No binding for "
272 << lyxaction.getActionName(func_->action())
273 << '(' << func_->argument() << ')');
277 /// the description of the submenu (if relevant)
278 QString const & submenuname() const { return submenuname_; }
279 /// set the description of the submenu
280 void submenuname(QString const & name) { submenuname_ = name; }
282 bool hasSubmenu() const { return !submenu_.isEmpty(); }
284 MenuDefinition const & submenu() const { return submenu_.at(0); }
285 MenuDefinition & submenu() { return submenu_[0]; }
287 void setSubmenu(MenuDefinition const & menu)
290 submenu_.append(menu);
299 shared_ptr<FuncRequest> func_;// non-null
301 QString submenuname_;
308 /// contains 0 or 1 item.
309 QList<MenuDefinition> submenu_;
313 class MenuDefinition {
316 typedef std::vector<MenuItem> ItemList;
318 typedef ItemList::const_iterator const_iterator;
320 explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
325 QString const & name() const { return name_; }
327 bool empty() const { return items_.empty(); }
328 /// Clear the menu content.
329 void clear() { items_.clear(); }
331 size_t size() const { return items_.size(); }
333 const_iterator begin() const { return items_.begin(); }
335 const_iterator end() const { return items_.end(); }
337 void cat(MenuDefinition const & other);
339 void catSub(docstring const & name);
341 // search for func in this menu iteratively, and put menu
343 bool searchMenu(FuncRequest const & func, docstring_list & names)
346 bool hasFunc(FuncRequest const &) const;
347 /// Add the menu item unconditionally
348 void add(MenuItem const & item) { items_.push_back(item); }
349 /// Checks the associated FuncRequest status before adding the
351 void addWithStatusCheck(MenuItem const &);
352 // Check whether the menu shortcuts are unique
353 void checkShortcuts() const;
355 void expandLastfiles();
356 void expandDocuments();
357 void expandBookmarks();
358 void expandFormats(MenuItem::Kind const kind, Buffer const * buf);
359 void expandFloatListInsert(Buffer const * buf);
360 void expandFloatInsert(Buffer const * buf);
361 void expandFlexInsert(Buffer const * buf, InsetLyXType type);
362 void expandTocSubmenu(std::string const & type, Toc const & toc_list);
363 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth, const string & toc_type);
364 void expandToc(Buffer const * buf);
365 void expandPasteRecent(Buffer const * buf);
366 void expandToolbars();
367 void expandBranches(Buffer const * buf);
368 void expandIndices(Buffer const * buf, bool listof = false);
369 void expandIndicesContext(Buffer const * buf, bool listof = false);
370 void expandCiteStyles(BufferView const *);
371 void expandInfoArguments(BufferView const *);
372 void expandGraphicsGroups(BufferView const *);
373 void expandSpellingSuggestions(BufferView const *);
374 void expandLanguageSelector(Buffer const * buf);
375 void expandArguments(BufferView const *, bool switcharg = false);
376 void expandCaptions(Buffer const * buf, bool switchcap = false);
377 void expandEnvironmentSeparators(BufferView const *, bool contextmenu = false);
378 void expandQuotes(BufferView const *);
379 void expandZoomOptions(BufferView const *);
387 /// Helper for std::find_if
391 MenuNamesEqual(QString const & name) : name_(name) {}
392 bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
399 typedef std::vector<MenuDefinition> MenuList;
401 typedef MenuList::const_iterator const_iterator;
403 typedef MenuList::iterator iterator;
405 /////////////////////////////////////////////////////////////////////
406 // MenuDefinition implementation
407 /////////////////////////////////////////////////////////////////////
409 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
413 case MenuItem::Command: {
414 FuncStatus status = lyx::getStatus(*i.func());
415 if (status.unknown() || (!status.enabled() && i.optional()))
418 items_.back().status(status);
422 case MenuItem::Submenu: {
423 bool enabled = false;
424 if (i.hasSubmenu()) {
425 for (const_iterator cit = i.submenu().begin();
426 cit != i.submenu().end(); ++cit) {
427 // Only these kind of items affect the status of the submenu
428 if ((cit->kind() == MenuItem::Command
429 || cit->kind() == MenuItem::Submenu
430 || cit->kind() == MenuItem::Help)
431 && cit->status().enabled()) {
437 if (enabled || !i.optional()) {
439 items_.back().status().setEnabled(enabled);
444 case MenuItem::Separator:
445 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
455 void MenuDefinition::read(Lexer & lex)
472 md_indiceslistscontext,
487 md_spellingsuggestions,
494 md_env_separatorscontext,
499 LexerKeyword menutags[] = {
500 { "arguments", md_arguments },
501 { "bookmarks", md_bookmarks },
502 { "branches", md_branches },
503 { "captions", md_captions },
504 { "charstyles", md_charstyles },
505 { "citestyles", md_citestyles },
506 { "custom", md_custom },
507 { "documents", md_documents },
508 { "end", md_endmenu },
509 { "environmentseparators", md_env_separators },
510 { "environmentseparatorscontext", md_env_separatorscontext },
511 { "exportformat", md_exportformat },
512 { "exportformats", md_exportformats },
513 { "floatinsert", md_floatinsert },
514 { "floatlistinsert", md_floatlistinsert },
515 { "graphicsgroups", md_graphicsgroups },
516 { "importformats", md_importformats },
517 { "indices", md_indices },
518 { "indicescontext", md_indicescontext },
519 { "indiceslists", md_indiceslists },
520 { "indiceslistscontext", md_indiceslistscontext },
521 { "infoarguments", md_infoarguments },
523 { "languageselector", md_languageselector },
524 { "lastfiles", md_lastfiles },
525 { "optitem", md_optitem },
526 { "optsubmenu", md_optsubmenu },
527 { "pasterecent", md_pasterecent },
528 { "separator", md_separator },
529 { "spellingsuggestions", md_spellingsuggestions },
530 { "submenu", md_submenu },
531 { "switcharguments", md_switcharguments },
532 { "switchcaptions", md_switchcaptions },
533 { "switchquotes", md_switchquotes },
535 { "toolbars", md_toolbars },
536 { "updateformats", md_updateformats },
537 { "viewformats", md_viewformats },
538 { "zoomoptions", md_zoomoptions }
541 lex.pushTable(menutags);
542 lex.setContext("MenuDefinition::read: ");
545 while (lex.isOK() && md_type != md_endmenu) {
546 switch (md_type = lex.lex()) {
550 docstring const name = translateIfPossible(lex.getDocString());
552 string const command = lex.getString();
553 FuncRequest func = lyxaction.lookupFunc(command);
554 FuncRequest::Origin origin = FuncRequest::MENU;
555 if (name_.startsWith("context-toc-"))
556 origin = FuncRequest::TOC;
557 bool const optional = (md_type == md_optitem);
558 add(MenuItem(MenuItem::Command, toqstr(name), func, QString(), optional, origin));
563 add(MenuItem(MenuItem::Separator));
567 add(MenuItem(MenuItem::Lastfiles));
571 add(MenuItem(MenuItem::CharStyles));
575 add(MenuItem(MenuItem::Custom));
579 add(MenuItem(MenuItem::Documents));
583 add(MenuItem(MenuItem::Bookmarks));
587 add(MenuItem(MenuItem::Toc));
591 add(MenuItem(MenuItem::ViewFormats));
594 case md_updateformats:
595 add(MenuItem(MenuItem::UpdateFormats));
598 case md_exportformats:
599 add(MenuItem(MenuItem::ExportFormats));
602 case md_exportformat:
603 add(MenuItem(MenuItem::ExportFormat));
606 case md_importformats:
607 add(MenuItem(MenuItem::ImportFormats));
610 case md_floatlistinsert:
611 add(MenuItem(MenuItem::FloatListInsert));
615 add(MenuItem(MenuItem::FloatInsert));
619 add(MenuItem(MenuItem::PasteRecent));
623 add(MenuItem(MenuItem::Toolbars));
627 add(MenuItem(MenuItem::Branches));
631 add(MenuItem(MenuItem::CiteStyles));
634 case md_infoarguments:
635 add(MenuItem(MenuItem::InfoArguments));
639 case md_graphicsgroups:
640 add(MenuItem(MenuItem::GraphicsGroups));
643 case md_spellingsuggestions:
644 add(MenuItem(MenuItem::SpellingSuggestions));
647 case md_languageselector:
648 add(MenuItem(MenuItem::LanguageSelector));
652 add(MenuItem(MenuItem::Indices));
655 case md_indicescontext:
656 add(MenuItem(MenuItem::IndicesContext));
659 case md_indiceslists:
660 add(MenuItem(MenuItem::IndicesLists));
663 case md_indiceslistscontext:
664 add(MenuItem(MenuItem::IndicesListsContext));
668 add(MenuItem(MenuItem::Arguments));
671 case md_switcharguments:
672 add(MenuItem(MenuItem::SwitchArguments));
676 add(MenuItem(MenuItem::Captions));
679 case md_switchcaptions:
680 add(MenuItem(MenuItem::SwitchCaptions));
683 case md_env_separators:
684 add(MenuItem(MenuItem::EnvironmentSeparators));
687 case md_env_separatorscontext:
688 add(MenuItem(MenuItem::EnvironmentSeparatorsContext));
691 case md_switchquotes:
692 add(MenuItem(MenuItem::SwitchQuotes));
696 add(MenuItem(MenuItem::ZoomOptions));
702 docstring const mlabel = translateIfPossible(lex.getDocString());
704 docstring const mname = lex.getDocString();
705 bool const optional = (md_type == md_optsubmenu);
706 add(MenuItem(MenuItem::Submenu,
707 toqstr(mlabel), toqstr(mname), QString(), optional));
715 lex.printError("Unknown menu tag");
723 bool MenuDefinition::hasFunc(FuncRequest const & func) const
725 for (auto const & it : *this)
726 if (*it.func() == func)
732 void MenuDefinition::catSub(docstring const & name)
734 add(MenuItem(MenuItem::Submenu,
735 qt_("More...|M"), toqstr(name), QString(), false));
738 void MenuDefinition::cat(MenuDefinition const & other)
740 const_iterator et = other.end();
741 for (const_iterator it = other.begin(); it != et; ++it)
746 void MenuDefinition::checkShortcuts() const
748 // This is a quadratic algorithm, but we do not care because
749 // menus are short enough
750 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
751 QString shortcut = it1->shortcut();
752 if (shortcut.isEmpty())
754 if (!it1->label().contains(shortcut))
755 LYXERR0("Menu warning: menu entry \""
757 << "\" does not contain shortcut `"
758 << shortcut << "'.");
759 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
760 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
761 LYXERR0("Menu warning: menu entries "
762 << '"' << it1->fulllabel()
763 << "\" and \"" << it2->fulllabel()
764 << "\" share the same shortcut.");
771 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
773 const_iterator m = begin();
774 const_iterator m_end = end();
775 for (; m != m_end; ++m) {
776 if (m->kind() == MenuItem::Command && *m->func() == func) {
777 names.push_back(qstring_to_ucs4(m->label()));
780 if (m->kind() == MenuItem::Submenu) {
781 names.push_back(qstring_to_ucs4(m->label()));
782 if (!m->hasSubmenu()) {
783 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
784 << m->label() << " name=" << m->submenuname());
788 if (m->submenu().searchMenu(func, names))
797 QString limitStringLength(docstring const & str)
799 size_t const max_item_length = 45;
800 docstring ret = str.substr(0, max_item_length + 1);
801 support::truncateWithEllipsis(ret, max_item_length);
806 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
811 graphics::getGraphicsGroups(bv->buffer(), grp);
815 set<string>::const_iterator it = grp.begin();
816 set<string>::const_iterator end = grp.end();
817 add(MenuItem(MenuItem::Command, qt_("No Group"),
818 FuncRequest(LFUN_GRAPHICS_SET_GROUP)));
819 for (; it != end; ++it) {
820 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it) + '|',
821 FuncRequest(LFUN_GRAPHICS_SET_GROUP, *it)));
826 void MenuDefinition::expandSpellingSuggestions(BufferView const * bv)
830 Cursor const & cur = bv->cursor();
834 docstring_list suggestions;
835 Paragraph const & par = cur.paragraph();
836 pos_type from = cur.pos();
838 SpellChecker::Result res = par.spellCheck(from, to, wl, suggestions, true, true);
840 case SpellChecker::UNKNOWN_WORD:
841 if (lyxrc.spellcheck_continuously) {
842 LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
843 docstring const & selection = cur.selectionAsString(false);
844 if (!cur.selection() || selection == wl.word()) {
846 size_t m = 10; // first submenu index
847 MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
848 item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
849 for (; i != suggestions.size(); ++i) {
850 docstring const & suggestion = suggestions[i];
851 LYXERR(Debug::GUI, suggestion);
852 MenuItem w(MenuItem::Command, toqstr(suggestion),
853 FuncRequest(LFUN_WORD_REPLACE,
854 replace2string(suggestion, selection,
855 true, // case sensitive
861 false))); // only selection
865 item.submenu().add(w);
870 add(MenuItem(MenuItem::Separator));
871 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
872 add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|n"),
873 FuncRequest(LFUN_SPELLING_ADD, arg)));
874 add(MenuItem(MenuItem::Command, qt_("Ignore this occurrence|g"),
875 FuncRequest(LFUN_FONT_NO_SPELLCHECK, arg)));
876 add(MenuItem(MenuItem::Command, qt_("Ignore all for this session|I"),
877 FuncRequest(LFUN_SPELLING_IGNORE, arg)));
878 add(MenuItem(MenuItem::Command, qt_("Ignore all in this document|d"),
879 FuncRequest(LFUN_SPELLING_ADD_LOCAL, arg)));
883 case SpellChecker::WORD_OK: {
884 if (wl.word().empty())
886 SpellChecker * speller = theSpellChecker();
887 if (speller && speller->canCheckParagraph())
889 LYXERR(Debug::GUI, "Valid Word.");
892 case SpellChecker::LEARNED_WORD: {
893 if (res == SpellChecker::LEARNED_WORD)
894 LYXERR(Debug::GUI, "Learned Word.");
895 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
896 add(MenuItem(MenuItem::Command, qt_("Remove from personal dictionary|r"),
897 FuncRequest(LFUN_SPELLING_REMOVE, arg)));
900 case SpellChecker::DOCUMENT_LEARNED_WORD: {
901 LYXERR(Debug::GUI, "Document-Learned Word.");
902 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
903 add(MenuItem(MenuItem::Command, qt_("Remove from document dictionary|r"),
904 FuncRequest(LFUN_SPELLING_REMOVE_LOCAL, arg)));
907 case SpellChecker::NO_DICTIONARY:
908 LYXERR(Debug::GUI, "No dictionary for language " + from_ascii(wl.lang()->lang()));
913 struct sortLanguageByName {
914 bool operator()(const Language * a, const Language * b) const {
915 return qt_(a->display()).localeAwareCompare(qt_(b->display())) < 0;
919 void MenuDefinition::expandLanguageSelector(Buffer const * buf)
924 std::set<Language const *> languages_buffer =
925 buf->masterBuffer()->getLanguages();
927 if (languages_buffer.size() < 2) {
928 add(MenuItem(MenuItem::Command, qt_("Switch Language...|L"),
929 FuncRequest(LFUN_DIALOG_SHOW, "character")));
933 std::set<Language const *, sortLanguageByName> langs;
935 std::set<Language const *>::const_iterator const beg =
936 languages_buffer.begin();
937 for (std::set<Language const *>::const_iterator cit = beg;
938 cit != languages_buffer.end(); ++cit) {
942 MenuItem item(MenuItem::Submenu, qt_("Language|L"));
943 item.setSubmenu(MenuDefinition(qt_("Language")));
944 QString morelangs = qt_("More Languages ...|M");
945 QStringList accelerators;
946 if (morelangs.contains('|'))
947 accelerators.append(morelangs.section('|', -1));
948 std::set<Language const *, sortLanguageByName>::const_iterator const begin = langs.begin();
949 for (std::set<Language const *, sortLanguageByName>::const_iterator cit = begin;
950 cit != langs.end(); ++cit) {
951 QString label = qt_((*cit)->display());
952 // try to add an accelerator
953 bool success = false;
954 // try capitals first
955 for (int i = 0; i < label.size(); ++i) {
956 QChar const ch = label[i];
959 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
960 label = label + toqstr("|") + ch;
961 accelerators.append(ch);
966 // if all capitals are taken, try the rest
968 for (int i = 0; i < label.size(); ++i) {
969 if (label[i].isSpace())
971 QString const ch = QString(label[i]);
972 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
973 label = label + toqstr("|") + ch;
974 accelerators.append(ch);
979 MenuItem w(MenuItem::Command, label,
980 FuncRequest(LFUN_LANGUAGE, (*cit)->lang() + " set"));
981 item.submenu().addWithStatusCheck(w);
983 item.submenu().add(MenuItem(MenuItem::Separator));
984 item.submenu().add(MenuItem(MenuItem::Command, morelangs,
985 FuncRequest(LFUN_DIALOG_SHOW, "character")));
990 void MenuDefinition::expandLastfiles()
992 LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
993 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
997 for (; lfit != lf.end() && ii <= lyxrc.num_lastfiles; ++lfit, ++ii) {
998 string const file = lfit->absFileName();
999 QString const short_path = toqstr(makeDisplayPath(file, 30));
1000 QString const long_path = toqstr(makeDisplayPath(file));
1003 label = QString("%1. %2|%3").arg(ii).arg(short_path).arg(ii);
1005 label = QString("%1. %2").arg(ii).arg(short_path);
1006 add(MenuItem(MenuItem::Command, label,
1007 FuncRequest(LFUN_FILE_OPEN, file), long_path));
1012 void MenuDefinition::expandDocuments()
1014 MenuItem item(MenuItem::Submenu, qt_("Hidden|H"));
1015 item.setSubmenu(MenuDefinition(qt_("Hidden|H")));
1017 Buffer * const first = theBufferList().first();
1019 add(MenuItem(MenuItem::Info, qt_("(No Documents Open)")));
1025 if (!guiApp->currentView())
1027 GuiWorkArea * wa = guiApp->currentView()->workArea(i);
1030 Buffer const & b = wa->bufferView().buffer();
1031 QString label = toqstr(b.fileName().displayName(20));
1034 if (b.notifiesExternalModification())
1035 label += QChar(0x26a0); // warning sign ⚠
1037 label = QString::number(i) + ". " + label + '|' + QString::number(i);
1038 add(MenuItem(MenuItem::Command, label,
1039 FuncRequest(LFUN_BUFFER_SWITCH, b.absFileName())));
1046 // We cannot use a for loop as the buffer list cycles.
1048 if (!(guiApp->currentView()
1049 && guiApp->currentView()->workArea(*b))) {
1050 QString label = toqstr(b->fileName().displayName(20));
1053 if (b->notifiesExternalModification())
1054 label += QChar(0x26a0);
1056 label = QString::number(i) + ". " + label + '|' + QString::number(i);
1057 item.submenu().add(MenuItem(MenuItem::Command, label,
1058 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
1061 b = theBufferList().next(b);
1062 } while (b != first);
1064 if (!item.submenu().empty())
1069 void MenuDefinition::expandBookmarks()
1071 lyx::BookmarksSection const & bm = theSession().bookmarks();
1074 for (size_t i = 1; i <= bm.size(); ++i) {
1075 if (bm.isValid(i)) {
1076 string const file = bm.bookmark(i).filename.absFileName();
1077 QString const label = QString("%1. %2|%3").arg(i)
1078 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
1079 add(MenuItem(MenuItem::Command, label,
1080 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
1085 add(MenuItem(MenuItem::Info, qt_("(No Bookmarks Saved Yet)")));
1089 void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf)
1091 if (!buf && kind != MenuItem::ImportFormats)
1095 FuncCode action = LFUN_NOACTION;
1098 case MenuItem::ImportFormats:
1099 formats = theConverters().importableFormats();
1100 action = LFUN_BUFFER_IMPORT;
1102 case MenuItem::ViewFormats:
1103 formats = buf->params().exportableFormats(true);
1104 action = LFUN_BUFFER_VIEW;
1106 case MenuItem::UpdateFormats:
1107 formats = buf->params().exportableFormats(true);
1108 action = LFUN_BUFFER_UPDATE;
1110 case MenuItem::ExportFormats:
1111 formats = buf->params().exportableFormats(false);
1112 action = LFUN_BUFFER_EXPORT;
1119 bool const view_update = (kind == MenuItem::ViewFormats
1120 || kind == MenuItem::UpdateFormats);
1124 smenue = (kind == MenuItem::ViewFormats
1125 ? qt_("View (Other Formats)|F")
1126 : qt_("Update (Other Formats)|p"));
1127 MenuItem item(MenuItem::Submenu, smenue);
1128 item.setSubmenu(MenuDefinition(smenue));
1130 for (Format const * f : formats) {
1134 docstring lab = f->prettyname();
1135 docstring const scut = from_utf8(f->shortcut());
1136 docstring const tmplab = lab;
1139 lab += char_type('|') + scut;
1140 docstring const lab_i18n = translateIfPossible(lab);
1141 docstring const shortcut = split(lab_i18n, lab, '|');
1143 bool const untranslated = (lab == lab_i18n);
1144 docstring label = untranslated ? translateIfPossible(tmplab) : lab;
1147 case MenuItem::ImportFormats:
1150 label += from_ascii("...");
1152 case MenuItem::ViewFormats:
1153 case MenuItem::UpdateFormats:
1154 if (f->name() == buf->params().getDefaultOutputFormat()) {
1155 docstring lbl = (kind == MenuItem::ViewFormats
1156 ? bformat(_("View [%1$s]|V"), label)
1157 : bformat(_("Update [%1$s]|U"), label));
1158 add(MenuItem(MenuItem::Command, toqstr(lbl), FuncRequest(action)));
1162 case MenuItem::ExportFormats:
1163 if (!f->inExportMenu())
1167 // we already asserted earlier in this case
1171 if (!shortcut.empty())
1172 label += '|' + shortcut;
1175 // note that at this point, we know that buf is not null
1177 item.submenu().addWithStatusCheck(MenuItem(MenuItem::Command,
1178 toqstr(label), FuncRequest(action, f->name())));
1181 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1182 FuncRequest(action, f->name())));
1184 add(MenuItem(MenuItem::Command, toqstr(label),
1185 FuncRequest(action, f->name())));
1193 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
1198 FloatList const & floats = buf->params().documentClass().floats();
1199 FloatList::const_iterator cit = floats.begin();
1200 FloatList::const_iterator end = floats.end();
1202 for (; cit != end; ++cit) {
1203 if (!cit->second.usesFloatPkg()) {
1204 // Different floats could declare the same ListCommand. We only
1205 // want it on the list once, though.
1206 string const & list_cmd = cit->second.listCommand();
1207 if (list_cmd.empty())
1208 // we do not know how to generate such a list
1210 // This form of insert returns an iterator pointing to the newly
1211 // inserted element OR the existing element with that value, and
1212 // a bool indicating whether we inserted a new element. So we can
1213 // see if one is there and insert it if not all at once.
1214 pair<set<string>::iterator, bool> ret = seen.insert(list_cmd);
1218 string const & list_name = cit->second.listName();
1219 addWithStatusCheck(MenuItem(MenuItem::Command, qt_(list_name),
1220 FuncRequest(LFUN_FLOAT_LIST_INSERT, cit->second.floattype())));
1225 void MenuDefinition::expandFloatInsert(Buffer const * buf)
1230 FloatList const & floats = buf->params().documentClass().floats();
1231 FloatList::const_iterator cit = floats.begin();
1232 FloatList::const_iterator end = floats.end();
1233 for (; cit != end; ++cit) {
1235 if (cit->second.name().empty())
1237 QString const label = qt_(cit->second.name());
1238 addWithStatusCheck(MenuItem(MenuItem::Command, label,
1239 FuncRequest(LFUN_FLOAT_INSERT,
1240 cit->second.floattype())));
1245 void MenuDefinition::expandFlexInsert(
1246 Buffer const * buf, InsetLyXType type)
1251 TextClass::InsetLayouts const & insetLayouts =
1252 buf->params().documentClass().insetLayouts();
1253 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
1254 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
1255 for (; cit != end; ++cit) {
1256 if (cit->second.lyxtype() == type) {
1257 if (!cit->second.obsoleted_by().empty())
1259 docstring name = cit->first;
1260 // we remove the "Flex:" prefix, if it is present
1261 if (prefixIs(name, from_ascii("Flex:")))
1262 name = name.substr(5);
1263 docstring const label = (cit->second.menustring().empty()) ?
1265 : cit->second.menustring();
1266 addWithStatusCheck(MenuItem(MenuItem::Command,
1267 toqstr(translateIfPossible(label)),
1268 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(name))));
1271 // FIXME This is a little clunky.
1272 if (items_.empty() && type == InsetLyXType::CUSTOM && !buf->hasReadonlyFlag())
1273 add(MenuItem(MenuItem::Help, qt_("(No Custom Insets Defined)")));
1277 // Threshold before we stop displaying sub-items alongside items
1278 // (for display purposes). Ideally this should fit on a screen.
1279 size_t const max_number_of_items = 30;
1280 // Size limit for the menu. This is for performance purposes,
1281 // because qt already displays a scrollable menu when necessary.
1282 // Ideally this should be the menu size from which scrollable
1283 // menus become unpractical.
1284 size_t const menu_size_limit = 80;
1286 void MenuDefinition::expandToc2(Toc const & toc_list,
1287 size_t from, size_t to, int depth,
1288 string const & toc_type)
1290 int shortcut_count = 0;
1292 // check whether depth is smaller than the smallest depth in toc.
1293 int min_depth = 1000;
1294 for (size_t i = from; i < to; ++i)
1295 min_depth = min(min_depth, toc_list[i].depth());
1296 if (min_depth > depth)
1299 if (to - from <= max_number_of_items) {
1300 for (size_t i = from; i < to; ++i) {
1301 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
1302 label += limitStringLength(toc_list[i].asString());
1303 if (toc_list[i].depth() == depth) {
1305 if (shortcut_count < 9) {
1306 if (label.contains(QString::number(shortcut_count + 1)))
1307 label += QString::number(++shortcut_count);
1310 add(MenuItem(MenuItem::Command, label, toc_list[i].action()));
1311 // separator after the menu heading
1312 if (toc_list[i].depth() < depth)
1313 add(MenuItem(MenuItem::Separator));
1319 size_t new_pos = pos + 1;
1320 while (new_pos < to && toc_list[new_pos].depth() > depth)
1323 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
1324 label += limitStringLength(toc_list[pos].asString());
1325 if (toc_list[pos].depth() == depth) {
1327 if (shortcut_count < 9) {
1328 if (label.contains(QString::number(shortcut_count + 1)))
1329 label += QString::number(++shortcut_count);
1332 if (size >= menu_size_limit) {
1333 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + toc_type);
1334 add(MenuItem(MenuItem::Command, "...", f));
1337 if (new_pos == pos + 1) {
1338 add(MenuItem(MenuItem::Command, label, toc_list[pos].action()));
1341 sub.expandToc2(toc_list, pos, new_pos, depth + 1, toc_type);
1342 MenuItem item(MenuItem::Submenu, label);
1343 item.setSubmenu(sub);
1353 void MenuDefinition::expandToc(Buffer const * buf)
1355 // To make things very cleanly, we would have to pass buf to
1356 // all MenuItem constructors and to expandToc2. However, we
1357 // know that all the entries in a TOC will be have status_ ==
1358 // OK, so we avoid this unnecessary overhead (JMarc)
1360 add(MenuItem(MenuItem::Info, qt_("(No Document Open)")));
1363 // Add an entry for the master doc if this is a child doc
1364 Buffer const * const master = buf->masterBuffer();
1365 if (buf != master) {
1366 ParIterator const pit = par_iterator_begin(master->inset());
1367 string const arg = convert<string>(pit->id());
1368 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
1369 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
1372 MenuDefinition other_lists;
1373 // In the navigation menu, only add tocs from this document
1374 TocBackend const & backend = buf->tocBackend();
1375 TocList const & toc_list = backend.tocs();
1376 for (pair<const string, shared_ptr<Toc>> const & toc : toc_list) {
1377 // Handle table of contents later
1378 if (toc.first == "tableofcontents" || toc.second->empty())
1380 MenuDefinition submenu;
1381 submenu.expandTocSubmenu(toc.first, *toc.second);
1382 docstring const toc_name = backend.outlinerName(toc.first);
1383 MenuItem item(MenuItem::Submenu, toqstr(toc_name));
1384 item.setSubmenu(submenu);
1385 // deserves to be in the main menu?
1386 if (!TocBackend::isOther(toc.first))
1389 other_lists.add(item);
1391 if (!other_lists.empty()) {
1392 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
1393 item.setSubmenu(other_lists);
1396 // Handle normal TOC
1397 add(MenuItem(MenuItem::Separator));
1398 TocList::const_iterator const cit = toc_list.find("tableofcontents");
1399 if (cit == toc_list.end())
1400 LYXERR(Debug::GUI, "No table of contents.");
1402 if (!cit->second->empty())
1403 expandToc2(*cit->second, 0, cit->second->size(), 0,
1406 add(MenuItem(MenuItem::Info, qt_("(Empty Table of Contents)")));
1411 void MenuDefinition::expandTocSubmenu(std::string const & type, Toc const & toc)
1413 // "Open outliner..." entry
1414 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + type);
1415 add(MenuItem(MenuItem::Command, qt_("Open Outliner..."), f));
1416 add(MenuItem(MenuItem::Separator));
1418 expandToc2(toc, 0, toc.size(), 0, type);
1422 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1424 docstring_list const sel = cap::availableSelections(buf);
1426 docstring_list::const_iterator cit = sel.begin();
1427 docstring_list::const_iterator end = sel.end();
1429 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1430 add(MenuItem(MenuItem::Command, toqstr(*cit) + '|',
1431 FuncRequest(LFUN_PASTE, convert<string>(index))));
1436 void MenuDefinition::expandToolbars()
1438 MenuDefinition other_lists;
1439 // extracts the toolbars from the backend
1440 Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1441 Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1442 for (; cit != end; ++cit) {
1443 MenuItem item(MenuItem::Command, toqstr(cit->gui_name),
1444 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1445 if (cit->allow_auto) {
1446 MenuDefinition tristate;
1447 tristate.add(MenuItem(MenuItem::Command, qt_("[[Toolbar]]On|O"),
1448 FuncRequest(LFUN_TOOLBAR_SET, cit->name + " on")));
1449 tristate.add(MenuItem(MenuItem::Command, qt_("[[Toolbar]]Off|f"),
1450 FuncRequest(LFUN_TOOLBAR_SET, cit->name + " off")));
1451 tristate.add(MenuItem(MenuItem::Command, qt_("[[Toolbar]]Automatic|A"),
1452 FuncRequest(LFUN_TOOLBAR_SET, cit->name + " auto")));
1453 item = MenuItem(MenuItem::Submenu,toqstr(cit->gui_name));
1454 item.setSubmenu(tristate);
1456 if (guiApp->toolbars().isMainToolbar(cit->name))
1459 other_lists.add(item);
1462 if (!other_lists.empty()) {
1463 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1464 item.setSubmenu(other_lists);
1470 void MenuDefinition::expandBranches(Buffer const * buf)
1472 if (!buf || buf->hasReadonlyFlag())
1475 BranchList const & child_list = buf->params().branchlist();
1476 set<docstring> brset;
1478 for (auto const & b : child_list) {
1479 docstring const & bname = b.branch();
1480 // NUM. Branch Name + "|", which triggers an empty shortcut in
1481 // case that character should be in the branch name.
1482 docstring label = convert<docstring>(ii) + ". " + bname + char_type('|');
1483 // Add NUM as a keyboard shortcut if it's a single digit
1485 label += convert<docstring>(ii);
1487 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1488 FuncRequest(LFUN_BRANCH_INSERT, bname)));
1490 brset.insert(bname);
1494 set<Buffer const *> bufset;
1495 Buffer const * nextbuf = buf->parent();
1496 MenuDefinition master_branches;
1499 // recursive includes are a bad idea, but let's not crash
1501 if (bufset.count(nextbuf))
1504 for (auto const & b : nextbuf->params().branchlist()) {
1505 docstring const & bname = b.branch();
1506 // do not add it if we've already seen it
1507 if (brset.count(bname))
1510 docstring label = convert<docstring>(ii) + ". " + bname + char_type('|');
1512 label += convert<docstring>(ii);
1514 master_branches.addWithStatusCheck(MenuItem(MenuItem::Command,
1515 toqstr(label), FuncRequest(LFUN_BRANCH_INSERT, bname)));
1517 bufset.insert(nextbuf);
1518 brset.insert(bname);
1522 nextbuf = nextbuf->parent();
1525 if (!master_branches.empty()) {
1526 MenuItem item(MenuItem::Submenu, qt_("Master Documents"));
1527 item.setSubmenu(master_branches);
1533 void MenuDefinition::expandIndices(Buffer const * buf, bool listof)
1538 BufferParams const & params = buf->masterBuffer()->params();
1539 if (!params.use_indices) {
1541 addWithStatusCheck(MenuItem(MenuItem::Command,
1542 qt_("Index List|I"),
1543 FuncRequest(LFUN_INDEX_PRINT,
1544 from_ascii("idx"))));
1546 addWithStatusCheck(MenuItem(MenuItem::Command,
1547 qt_("Index Entry|d"),
1548 FuncRequest(LFUN_INDEX_INSERT,
1549 from_ascii("idx"))));
1553 if (params.indiceslist().empty())
1556 IndicesList::const_iterator cit = params.indiceslist().begin();
1557 IndicesList::const_iterator end = params.indiceslist().end();
1559 for (int ii = 1; cit != end; ++cit, ++ii) {
1561 docstring const label =
1562 bformat(_("Index: %1$s"), cit->index());
1563 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1564 FuncRequest(LFUN_INDEX_PRINT, cit->shortcut())));
1566 docstring const label =
1567 bformat(_("Index Entry (%1$s)"), cit->index());
1568 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1569 FuncRequest(LFUN_INDEX_INSERT, cit->shortcut())));
1575 void MenuDefinition::expandIndicesContext(Buffer const * buf, bool listof)
1580 BufferParams const & params = buf->masterBuffer()->params();
1581 if (!params.use_indices || params.indiceslist().empty())
1584 IndicesList::const_iterator cit = params.indiceslist().begin();
1585 IndicesList::const_iterator end = params.indiceslist().end();
1587 for (int ii = 1; cit != end; ++cit, ++ii) {
1589 InsetCommandParams p(INDEX_PRINT_CODE);
1590 p["type"] = cit->shortcut();
1591 string const data = InsetCommand::params2string(p);
1592 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
1593 FuncRequest(LFUN_INSET_MODIFY, data)));
1595 docstring const label =
1596 bformat(_("Index Entry (%1$s)"), cit->index());
1597 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1598 FuncRequest(LFUN_INSET_MODIFY,
1599 from_ascii("changetype ") + cit->shortcut())));
1605 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1610 Inset const * inset = bv->cursor().nextInset();
1611 if (!inset || inset->lyxCode() != CITE_CODE) {
1612 add(MenuItem(MenuItem::Command,
1613 qt_("No Citation in Scope!"),
1614 FuncRequest(LFUN_NOACTION)));
1617 InsetCitation const * citinset =
1618 static_cast<InsetCitation const *>(inset);
1620 Buffer const * buf = &bv->buffer();
1621 BufferParams const & bp = buf->masterParams();
1622 string const cmd = citinset->params().getCmdName();
1624 docstring const & key = citinset->getParam("key");
1626 add(MenuItem(MenuItem::Command,
1627 qt_("No citations selected!"),
1628 FuncRequest(LFUN_NOACTION)));
1632 bool const force = isUpperCase(cmd[0]);
1633 bool const star = suffixIs(cmd, '*');
1635 vector<docstring> const keys = getVectorFromString(key);
1637 vector<CitationStyle> const citeStyleList = bp.citeStyles();
1639 CitationStyle cs = citinset->getCitationStyle(bp, cmd, citeStyleList);
1640 bool const qualified = cs.hasQualifiedList
1642 || !citinset->getParam("pretextlist").empty()
1643 || !citinset->getParam("posttextlist").empty());
1644 vector<pair<docstring, docstring>> pres =
1645 citinset->getQualifiedLists(citinset->getParam("pretextlist"));
1646 vector<pair<docstring, docstring>> posts =
1647 citinset->getQualifiedLists(citinset->getParam("posttextlist"));
1650 ci.textBefore = citinset->getParam("before");
1651 ci.textAfter = citinset->getParam("after");
1652 ci.forceUpperCase = force;
1654 ci.context = CiteItem::Dialog;
1656 ci.isQualified = qualified;
1658 ci.posttexts = posts;
1659 BiblioInfo::CiteStringMap citeStrings =
1660 buf->masterBibInfo().getCiteStrings(keys, citeStyleList, bv->buffer(), ci);
1662 BiblioInfo::CiteStringMap::const_iterator cit = citeStrings.begin();
1663 BiblioInfo::CiteStringMap::const_iterator end = citeStrings.end();
1665 for (int ii = 1; cit != end; ++cit, ++ii) {
1666 docstring label = cit->second;
1667 CitationStyle ccs = citeStyleList[ii - 1];
1668 ccs.forceUpperCase &= force;
1669 ccs.hasStarredVersion &= star;
1670 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1671 FuncRequest(LFUN_INSET_MODIFY,
1672 "changetype " + from_utf8(citationStyleToString(ccs)))));
1675 if (cs.hasStarredVersion) {
1676 docstring starred = _("All authors|h");
1677 // Check if we have a custom string/tooltip for the starred version
1678 if (!cs.stardesc.empty()) {
1680 bp.documentClass().getCiteMacro(buf->params().citeEngineType(), cs.stardesc);
1682 starred = translateIfPossible(from_utf8(val));
1683 // Transform qt-style accelerators to menu-style
1684 int const amps = count_char(starred, '&');
1687 starred = subst(starred, from_ascii("&&"), from_ascii("<:amp:>"));
1688 size_t nn = starred.find('&');
1689 char_type accel = char_type();
1690 if (nn != docstring::npos && nn < starred.size() - 1)
1691 accel = starred[nn + 1];
1692 starred = subst(starred, from_ascii("&"), from_ascii(""));
1694 starred = subst(starred, from_ascii("<:amp:>"), from_ascii("&&"));
1695 if (accel != char_type())
1696 starred = starred + '|' + accel;
1699 add(MenuItem(MenuItem::Separator));
1700 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(starred),
1701 FuncRequest(LFUN_INSET_MODIFY, "toggleparam star")));
1704 if (cs.forceUpperCase) {
1705 if (!cs.hasStarredVersion)
1706 add(MenuItem(MenuItem::Separator));
1707 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(_("Force upper case|u")),
1708 FuncRequest(LFUN_INSET_MODIFY, "toggleparam casing")));
1713 void MenuDefinition::expandInfoArguments(BufferView const * bv)
1718 Inset const * inset = bv->cursor().nextInset();
1719 if (!inset || inset->lyxCode() != INFO_CODE) {
1720 add(MenuItem(MenuItem::Command,
1721 qt_("No Text Field in Scope!"),
1722 FuncRequest(LFUN_NOACTION)));
1725 InsetInfo const * iinset = static_cast<InsetInfo const *>(inset);
1727 string const type = iinset->params().infoType();
1728 vector<pair<string,docstring>> const args =
1729 iinset->params().getArguments(&bv->buffer(), type);
1731 // Don't generate a menu for big lists (such as lfuns and rcs)
1732 if (args.size() > 15)
1735 for (auto const & p : args) {
1736 if (p.first == "invalid")
1739 if (p.first == "custom") {
1740 add(MenuItem(MenuItem::Command, qt_("Custom..."),
1741 FuncRequest(LFUN_INSET_SETTINGS, "info")));
1744 docstring label = p.second;
1745 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1746 FuncRequest(LFUN_INSET_MODIFY, type + " " + p.first)));
1752 void MenuDefinition::expandArguments(BufferView const * bv, bool switcharg)
1757 if (!bv->cursor().inTexted())
1760 Inset const * inset = &bv->cursor().inset();
1761 Layout::LaTeXArgMap args = bv->cursor().paragraph().layout().args();
1762 if (inset && args.empty())
1763 args = inset->getLayout().args();
1764 if (args.empty() || (switcharg && args.size() == 1))
1766 Layout::LaTeXArgMap::const_iterator lait = args.begin();
1767 Layout::LaTeXArgMap::const_iterator const laend = args.end();
1768 for (; lait != laend; ++lait) {
1769 Layout::latexarg arg = (*lait).second;
1770 docstring str = arg.menustring.empty()? arg.labelstring : arg.menustring;
1771 QString item = toqstr(translateIfPossible(str));
1773 add(MenuItem(MenuItem::Command, item,
1774 FuncRequest(LFUN_INSET_MODIFY,
1775 from_ascii("changetype ")
1776 + from_ascii((*lait).first))));
1778 add(MenuItem(MenuItem::Command, item,
1779 FuncRequest(LFUN_ARGUMENT_INSERT,
1780 from_ascii((*lait).first))));
1785 void MenuDefinition::expandCaptions(Buffer const * buf, bool switchcap)
1790 DocumentClass const & dc = buf->params().documentClass();
1791 vector< pair<docstring, FuncRequest> > caps;
1792 for (pair<const docstring, InsetLayout> const & il : dc.insetLayouts()) {
1794 docstring const type = split(il.first, instype, ':');
1795 if (instype == from_ascii("Caption")) {
1796 // skip forbidden caption types
1797 FuncRequest const cmd = switchcap
1798 ? FuncRequest(LFUN_INSET_MODIFY, from_ascii("changetype ") + type)
1799 : FuncRequest(LFUN_CAPTION_INSERT, type);
1800 if (getStatus(cmd).enabled())
1801 caps.push_back(make_pair(type, cmd));
1805 if (caps.empty() || (switchcap && caps.size() == 1))
1807 if (caps.size() == 1) {
1808 add(MenuItem(MenuItem::Command, qt_("Caption"), caps.front().second));
1812 MenuDefinition captions;
1813 for (pair<docstring, FuncRequest> const & cap : caps) {
1814 docstring const type = cap.first;
1815 docstring const trtype = translateIfPossible(type);
1816 docstring const cmitem = bformat(_("Caption (%1$s)"), trtype);
1818 add(MenuItem(MenuItem::Command, toqstr(cmitem), cap.second));
1820 captions.add(MenuItem(MenuItem::Command, toqstr(trtype), cap.second));
1822 if (!captions.empty()) {
1823 MenuItem item(MenuItem::Submenu, qt_("Caption"));
1824 item.setSubmenu(captions);
1830 void MenuDefinition::expandZoomOptions(BufferView const * bv)
1835 add(MenuItem(MenuItem::Command,
1836 toqstr(bformat(_("Reset to Default (%1$d%)|R"),
1837 lyxrc.defaultZoom)),
1838 FuncRequest(LFUN_BUFFER_ZOOM)));
1839 add(MenuItem(MenuItem::Command, qt_("Zoom In|I"),
1840 FuncRequest(LFUN_BUFFER_ZOOM_IN)));
1841 add(MenuItem(MenuItem::Command, qt_("Zoom Out|O"),
1842 FuncRequest(LFUN_BUFFER_ZOOM_OUT)));
1843 add(MenuItem(MenuItem::Separator));
1844 // Offer some fractional values of the default
1845 int z = lyxrc.defaultZoom * 1.75;
1846 add(MenuItem(MenuItem::Command,
1847 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1848 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1849 z = lyxrc.defaultZoom * 1.5;
1850 add(MenuItem(MenuItem::Command,
1851 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1852 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1853 z = lyxrc.defaultZoom * 1.25;
1854 add(MenuItem(MenuItem::Command,
1855 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1856 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1857 z = lyxrc.defaultZoom * 0.75;
1858 add(MenuItem(MenuItem::Command,
1859 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1860 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1861 z = lyxrc.defaultZoom * 0.5;
1862 add(MenuItem(MenuItem::Command,
1863 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1864 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1865 z = lyxrc.defaultZoom * 0.25;
1866 add(MenuItem(MenuItem::Command,
1867 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1868 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1872 void MenuDefinition::expandQuotes(BufferView const * bv)
1877 if (!bv->cursor().inTexted())
1880 Inset const * inset = bv->cursor().nextInset();
1881 if (!inset || inset->lyxCode() != QUOTE_CODE) {
1882 add(MenuItem(MenuItem::Command,
1883 qt_("No Quote in Scope!"),
1884 FuncRequest(LFUN_NOACTION)));
1887 InsetQuotes const * qinset =
1888 static_cast<InsetQuotes const *>(inset);
1890 string const qtype = qinset->getType();
1894 BufferParams const & bp = bv->buffer().masterBuffer()->params();
1896 // The global setting
1897 QuoteStyle globalqs = bp.quotes_style;
1898 char const globalqsc = quoteparams.getStyleChar(globalqs);
1900 // The current language's default
1901 QuoteStyle langdefqs =
1902 bp.getQuoteStyle(bv->cursor().current_font.language()->quoteStyle());
1903 char const langqs = quoteparams.getStyleChar(langdefqs);
1905 bool main_global_qs = false;
1906 bool main_langdef_qs = false;
1907 bool main_dynamic_qs = false;
1908 docstring const subcmd = from_ascii("changetype ");
1909 docstring const wildcards = from_ascii("..");
1911 // First the top level menu (all glyphs of the current style) ...
1912 // Begin with dynamic (if they are current style),
1913 if (qtype[0] == 'x') {
1914 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + from_ascii("xld"));
1915 docstring desc = bformat(_("%1$s (dynamic)"),
1916 quoteparams.getShortGuiLabel(globalqsc + from_ascii("ld")));
1917 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1918 cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + from_ascii("xls"));
1919 desc = bformat(_("%1$s (dynamic)"),
1920 quoteparams.getShortGuiLabel(globalqsc + from_ascii("ls")));
1921 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1922 cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + from_ascii("xrd"));
1923 desc = bformat(_("%1$s (dynamic)"),
1924 quoteparams.getShortGuiLabel(globalqsc + from_ascii("rd")));
1925 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1926 cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + from_ascii("xrs"));
1927 desc = bformat(_("%1$s (dynamic)"),
1928 quoteparams.getShortGuiLabel(globalqsc + from_ascii("rs")));
1929 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1930 main_dynamic_qs = true;
1932 // now traverse through the static styles ...
1933 map<string, docstring> styles = quoteparams.getTypes();
1934 for (auto const & s : styles) {
1935 char style_char = (s.first)[0];
1936 bool langdef = (style_char == langqs);
1937 bool globaldef = (style_char == globalqsc);
1938 docstring const style = from_ascii(s.first);
1940 if (prefixIs(style, qtype[0])) {
1941 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + style);
1942 docstring const desc = quoteparams.getShortGuiLabel(style);
1943 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1944 main_global_qs = globaldef;
1945 main_langdef_qs = langdef;
1947 else if (!langdef && !globaldef && suffixIs(style, from_ascii("ld"))) {
1948 docstring const desc =
1949 quoteparams.getGuiLabel(quoteparams.getQuoteStyle(to_ascii(style)));
1950 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + style[0] + "..");
1951 aqs.add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1955 add(MenuItem(MenuItem::Separator));
1957 bool display_static = false;
1958 // ... then potentially items to reset to the defaults and to dynamic style ...
1959 if (!main_dynamic_qs && globalqsc != 'x') {
1960 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + 'x' + wildcards);
1961 docstring const desc = bformat(_("Use dynamic quotes (%1$s)|d"),
1962 quoteparams.getGuiLabel(globalqs));
1963 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1964 display_static = true;
1966 if (!main_global_qs && langdefqs != globalqs) {
1967 docstring const variant = main_dynamic_qs ? _("dynamic[[Quotes]]") : _("static[[Quotes]]");
1968 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + globalqsc + wildcards);
1969 docstring const desc = bformat(_("Reset to document default (%1$s, %2$s)|o"),
1970 quoteparams.getGuiLabel(globalqs), variant);
1971 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1973 if (!main_langdef_qs) {
1974 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + globalqsc + wildcards);
1975 docstring const desc = (main_dynamic_qs || display_static)
1976 ? bformat(_("Reset to language default (%1$s, %2$s)|l"),
1977 quoteparams.getGuiLabel(langdefqs), _("static[[Quotes]]"))
1978 : bformat(_("Reset to language default (%1$s)|l"),
1979 quoteparams.getGuiLabel(langdefqs));
1980 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1983 add(MenuItem(MenuItem::Separator));
1985 // ... and a subitem with the rest
1986 MenuItem item(MenuItem::Submenu, qt_("Change Style|y"));
1987 item.setSubmenu(aqs);
1992 void MenuDefinition::expandEnvironmentSeparators(BufferView const * bv,
1997 Text const * text = bv->cursor().text();
1998 // no paragraphs and no separators exist in math
2002 pit_type pit = bv->cursor().selBegin().pit();
2003 Paragraph const & par = text->getPar(pit);
2004 docstring const curlayout = par.layout().name();
2005 docstring outerlayout;
2006 docstring prevlayout;
2007 depth_type current_depth = par.params().depth();
2008 // check if we have an environment in our scope
2013 Paragraph cpar = text->getPar(pit);
2014 if (cpar.layout().isEnvironment() && prevlayout.empty()
2015 && cpar.params().depth() <= current_depth)
2016 prevlayout = cpar.layout().name();
2017 if (cpar.params().depth() < current_depth
2018 && cpar.layout().isEnvironment()) {
2019 outerlayout = cpar.layout().name();
2020 current_depth = cpar.params().depth();
2022 if (cpar.params().depth() == 0)
2025 if (par.layout().isEnvironment()) {
2026 docstring label = contextmenu ?
2027 bformat(_("Insert Separated %1$s Above"),
2028 translateIfPossible(curlayout)) :
2029 bformat(_("Separated %1$s Above"),
2030 translateIfPossible(curlayout));
2031 add(MenuItem(MenuItem::Command, toqstr(label),
2032 FuncRequest(LFUN_ENVIRONMENT_SPLIT,
2033 from_ascii("before"))));
2034 label = contextmenu ?
2035 bformat(_("Insert Separated %1$s Below"),
2036 translateIfPossible(curlayout)):
2037 bformat(_("Separated %1$s Below"),
2038 translateIfPossible(curlayout));
2039 // We use command-alternatives here since this is how the binding is defined
2040 // (otherwise, the binding is not displayed in the menu)
2041 if (getStatus(FuncRequest(LFUN_ENVIRONMENT_SPLIT)).enabled())
2042 add(MenuItem(MenuItem::Command, toqstr(label),
2043 FuncRequest(LFUN_COMMAND_ALTERNATIVES,
2044 from_ascii("environment-split ; environment-split previous"))));
2046 else if (!prevlayout.empty()) {
2047 docstring const label = contextmenu ?
2048 bformat(_("Insert Separated %1$s Below"),
2049 translateIfPossible(prevlayout)) :
2050 bformat(_("Separated %1$s Below"),
2051 translateIfPossible(prevlayout));
2052 // We use command-alternatives here since this is how the binding is defined
2053 // (otherwise, the binding is not displayed in the menu)
2054 if (getStatus(FuncRequest(LFUN_ENVIRONMENT_SPLIT)).enabled())
2055 add(MenuItem(MenuItem::Command, toqstr(label),
2056 FuncRequest(LFUN_COMMAND_ALTERNATIVES,
2057 from_ascii("environment-split ; environment-split previous"))));
2059 if (!outerlayout.empty()) {
2062 label = (outerlayout == curlayout) ?
2063 bformat(_("Insert Separated Outer %1$s Below"),
2064 translateIfPossible(outerlayout)) :
2065 bformat(_("Insert Separated %1$s Below"),
2066 translateIfPossible(outerlayout));
2068 label = (outerlayout == curlayout) ?
2069 bformat(_("Separated Outer %1$s Below"),
2070 translateIfPossible(outerlayout)) :
2071 bformat(_("Separated %1$s Below"),
2072 translateIfPossible(outerlayout));
2074 add(MenuItem(MenuItem::Command, toqstr(label),
2075 FuncRequest(LFUN_ENVIRONMENT_SPLIT,
2076 from_ascii("outer"))));
2083 /////////////////////////////////////////////////////////////////////
2084 // Menu::Impl definition and implementation
2085 /////////////////////////////////////////////////////////////////////
2089 /// populates the menu or one of its submenu
2090 /// This is used as a recursive function
2091 void populate(QMenu * qMenu, MenuDefinition const & menu);
2093 /// Only needed for top level menus.
2094 MenuDefinition * top_level_menu;
2097 /// the name of this menu
2103 /// Get a MenuDefinition item label from the menu backend
2104 static QString label(MenuItem const & mi)
2106 QString label = mi.label();
2107 label.replace("&", "&&");
2109 QString shortcut = mi.shortcut();
2110 if (!shortcut.isEmpty()) {
2111 int pos = label.indexOf(shortcut);
2113 //label.insert(pos, 1, char_type('&'));
2114 label.replace(pos, 0, "&");
2117 QString const binding = mi.binding();
2118 if (!binding.isEmpty())
2119 label += '\t' + binding;
2124 void Menu::Impl::populate(QMenu * qMenu, MenuDefinition const & menu)
2126 LYXERR(Debug::GUI, "populating menu " << menu.name());
2128 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
2131 LYXERR(Debug::GUI, " ***** menu entries " << menu.size());
2132 for (MenuItem const & m : menu)
2134 case MenuItem::Separator:
2135 qMenu->addSeparator();
2137 case MenuItem::Submenu: {
2138 QMenu * subMenu = qMenu->addMenu(label(m));
2139 populate(subMenu, m.submenu());
2140 subMenu->setEnabled(!subMenu->isEmpty());
2143 case MenuItem::Command:
2145 // FIXME: A previous comment assured that MenuItem::Command was the
2146 // only possible case in practice, but this is wrong. It would be
2147 // good to document which cases are actually treated here.
2148 qMenu->addAction(new Action(m.func(), QIcon(), label(m),
2149 m.tooltip(), qMenu));
2154 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
2155 class AlwaysMnemonicStyle : public QProxyStyle {
2157 int styleHint(StyleHint hint, const QStyleOption *opt = 0, const QWidget *widget = 0,
2158 QStyleHintReturn *returnData = 0) const override
2160 if (hint == QStyle::SH_UnderlineShortcut)
2162 return QProxyStyle::styleHint(hint, opt, widget, returnData);
2167 /////////////////////////////////////////////////////////////////////
2168 // Menu implementation
2169 /////////////////////////////////////////////////////////////////////
2171 Menu::Menu(GuiView * gv, QString const & name, bool top_level, bool keyboard)
2172 : QMenu(gv), d(new Menu::Impl)
2174 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
2176 setStyle(new AlwaysMnemonicStyle);
2180 d->top_level_menu = top_level? new MenuDefinition : 0;
2184 if (d->top_level_menu)
2185 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
2191 delete d->top_level_menu;
2196 void Menu::updateView()
2198 guiApp->menus().updateMenu(this);
2204 QList<QAction *> items = actions();
2205 for (int i = 0; i != items.size(); ++i) {
2206 // QAction::menu() returns 0 if there's no submenu.
2207 delete items.at(i)->menu();
2213 /////////////////////////////////////////////////////////////////////
2214 // Menus::Impl definition and implementation
2215 /////////////////////////////////////////////////////////////////////
2217 struct Menus::Impl {
2219 bool hasMenu(QString const &) const;
2221 MenuDefinition & getMenu(QString const &);
2223 MenuDefinition const & getMenu(QString const &) const;
2225 /// Expands some special entries of the menu
2226 /** The entries with the following kind are expanded to a
2227 sequence of Command MenuItems: Lastfiles, Documents,
2228 ViewFormats, ExportFormats, UpdateFormats, Branches,
2229 Indices, Arguments, SwitchArguments, Captions, SwitchCaptions,
2230 EnvironmentSeparators
2232 void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
2233 BufferView const *) const;
2235 /// Initialize specific MACOS X menubar
2236 void macxMenuBarInit(QMenuBar * qmb);
2238 /// Mac special menu.
2239 /** This defines a menu whose entries list the FuncRequests
2240 that will be removed by expand() in other menus. This is
2241 used by the Qt/Mac code.
2243 NOTE: Qt does not remove the menu items when clearing a QMenuBar,
2244 such that the items will keep accessing the FuncRequests in
2245 the MenuDefinition. While Menus::Impl might be recreated,
2246 we keep mac_special_menu_ in memory by making it static.
2248 static MenuDefinition mac_special_menu_;
2253 MenuDefinition menubar_;
2255 typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
2257 /// name to menu for \c menu() method.
2262 MenuDefinition Menus::Impl::mac_special_menu_;
2266 Here is what the Qt documentation says about how a menubar is chosen:
2268 1) If the window has a QMenuBar then it is used. 2) If the window
2269 is a modal then its menubar is used. If no menubar is specified
2270 then a default menubar is used (as documented below) 3) If the
2271 window has no parent then the default menubar is used (as
2274 The above 3 steps are applied all the way up the parent window
2275 chain until one of the above are satisfied. If all else fails a
2276 default menubar will be created, the default menubar on Qt/Mac is
2277 an empty menubar, however you can create a different default
2278 menubar by creating a parentless QMenuBar, the first one created
2279 will thus be designated the default menubar, and will be used
2280 whenever a default menubar is needed.
2282 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
2283 that this menubar will be used also when one of LyX' dialogs has
2286 void Menus::Impl::macxMenuBarInit(QMenuBar * qmb)
2288 /* Since Qt 4.2, the qt/mac menu code has special code for
2289 specifying the role of a menu entry. However, it does not
2290 work very well with our scheme of creating menus on demand,
2291 and therefore we need to put these entries in a special
2292 invisible menu. (JMarc)
2295 /* The entries of our special mac menu. If we add support for
2296 * special entries in Menus, we could imagine something
2298 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
2299 * and therefore avoid hardcoding. I am not sure it is worth
2300 * the hassle, though. (JMarc)
2302 struct MacMenuEntry {
2306 QAction::MenuRole role;
2309 static const MacMenuEntry entries[] = {
2310 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
2311 QAction::AboutRole},
2312 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
2313 QAction::PreferencesRole},
2314 #if !(defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
2315 /* This doesn't work with Cocoa. */
2316 {LFUN_RECONFIGURE, "", "Reconfigure",
2317 QAction::ApplicationSpecificRole},
2319 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
2321 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
2322 const bool first_call = mac_special_menu_.empty();
2324 LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
2325 // the special menu for Menus. Fill it up only once.
2327 for (size_t i = 0 ; i < num_entries ; ++i) {
2328 FuncRequest const func(entries[i].action,
2329 from_utf8(entries[i].arg));
2330 mac_special_menu_.add(MenuItem(MenuItem::Command,
2331 entries[i].label, func));
2335 // add the entries to a QMenu that will eventually be empty
2336 // and therefore invisible.
2337 QMenu * qMenu = qmb->addMenu("special");
2339 for (MenuItem const & m : mac_special_menu_) {
2340 Action * action = new Action(m.func(), QIcon(), m.label(),
2342 action->setMenuRole(entries[i].role);
2343 qMenu->addAction(action);
2349 void Menus::Impl::expand(MenuDefinition const & frommenu,
2350 MenuDefinition & tomenu, BufferView const * bv) const
2352 if (!tomenu.empty())
2355 for (MenuDefinition::const_iterator cit = frommenu.begin();
2356 cit != frommenu.end() ; ++cit) {
2357 Buffer const * buf = bv ? &bv->buffer() : 0;
2358 switch (cit->kind()) {
2359 case MenuItem::Lastfiles:
2360 tomenu.expandLastfiles();
2363 case MenuItem::Documents:
2364 tomenu.expandDocuments();
2367 case MenuItem::Bookmarks:
2368 tomenu.expandBookmarks();
2371 case MenuItem::ImportFormats:
2372 case MenuItem::ViewFormats:
2373 case MenuItem::UpdateFormats:
2374 case MenuItem::ExportFormats:
2375 tomenu.expandFormats(cit->kind(), buf);
2378 case MenuItem::ExportFormat: {
2381 string const format = buf->params().getDefaultOutputFormat();
2382 Format const * f = theFormats().getFormat(format);
2383 docstring const name = f ? translateIfPossible(f->prettyname())
2384 : from_utf8(format);
2385 docstring const label = bformat(_("Export [%1$s]|E"), name);
2386 MenuItem item(MenuItem::Command, toqstr(label),
2387 FuncRequest(LFUN_BUFFER_EXPORT));
2388 tomenu.addWithStatusCheck(item);
2392 case MenuItem::CharStyles:
2393 tomenu.expandFlexInsert(buf, InsetLyXType::CHARSTYLE);
2396 case MenuItem::Custom:
2397 tomenu.expandFlexInsert(buf, InsetLyXType::CUSTOM);
2400 case MenuItem::FloatListInsert:
2401 tomenu.expandFloatListInsert(buf);
2404 case MenuItem::FloatInsert:
2405 tomenu.expandFloatInsert(buf);
2408 case MenuItem::PasteRecent:
2409 tomenu.expandPasteRecent(buf);
2412 case MenuItem::Toolbars:
2413 tomenu.expandToolbars();
2416 case MenuItem::Branches:
2417 tomenu.expandBranches(buf);
2420 case MenuItem::Indices:
2421 tomenu.expandIndices(buf);
2424 case MenuItem::IndicesContext:
2425 tomenu.expandIndicesContext(buf);
2428 case MenuItem::IndicesLists:
2429 tomenu.expandIndices(buf, true);
2432 case MenuItem::IndicesListsContext:
2433 tomenu.expandIndicesContext(buf, true);
2436 case MenuItem::CiteStyles:
2437 tomenu.expandCiteStyles(bv);
2440 case MenuItem::InfoArguments:
2441 tomenu.expandInfoArguments(bv);
2446 tomenu.expandToc(buf);
2449 case MenuItem::GraphicsGroups:
2450 tomenu.expandGraphicsGroups(bv);
2453 case MenuItem::SpellingSuggestions:
2454 tomenu.expandSpellingSuggestions(bv);
2457 case MenuItem::LanguageSelector:
2458 tomenu.expandLanguageSelector(buf);
2461 case MenuItem::Arguments:
2462 tomenu.expandArguments(bv, false);
2465 case MenuItem::SwitchArguments:
2466 tomenu.expandArguments(bv, true);
2469 case MenuItem::Captions:
2470 tomenu.expandCaptions(buf, false);
2473 case MenuItem::SwitchCaptions:
2474 tomenu.expandCaptions(buf, true);
2477 case MenuItem::EnvironmentSeparators:
2478 tomenu.expandEnvironmentSeparators(bv);
2481 case MenuItem::EnvironmentSeparatorsContext:
2482 tomenu.expandEnvironmentSeparators(bv, true);
2485 case MenuItem::SwitchQuotes:
2486 tomenu.expandQuotes(bv);
2489 case MenuItem::ZoomOptions:
2490 tomenu.expandZoomOptions(bv);
2493 case MenuItem::Submenu: {
2494 MenuItem item(*cit);
2495 item.setSubmenu(MenuDefinition(cit->submenuname()));
2496 expand(getMenu(cit->submenuname()), item.submenu(), bv);
2497 tomenu.addWithStatusCheck(item);
2501 case MenuItem::Info:
2502 case MenuItem::Help:
2503 case MenuItem::Separator:
2504 tomenu.addWithStatusCheck(*cit);
2507 case MenuItem::Command:
2508 if (!mac_special_menu_.hasFunc(*cit->func()))
2509 tomenu.addWithStatusCheck(*cit);
2513 // we do not want the menu to end with a separator
2514 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
2515 tomenu.items_.pop_back();
2517 // Check whether the shortcuts are unique
2518 tomenu.checkShortcuts();
2522 bool Menus::Impl::hasMenu(QString const & name) const
2524 return find_if(menulist_.begin(), menulist_.end(),
2525 MenuNamesEqual(name)) != menulist_.end();
2529 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
2531 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
2532 MenuNamesEqual(name));
2533 if (cit == menulist_.end()) {
2534 LYXERR0("No submenu named " << name);
2535 LASSERT(false, { static const MenuDefinition m; return m; });
2541 MenuDefinition & Menus::Impl::getMenu(QString const & name)
2543 iterator it = find_if(menulist_.begin(), menulist_.end(),
2544 MenuNamesEqual(name));
2545 if (it == menulist_.end()) {
2546 LYXERR0("No submenu named " << name);
2547 LASSERT(false, { static MenuDefinition m; return m; });
2553 /////////////////////////////////////////////////////////////////////
2557 /////////////////////////////////////////////////////////////////////
2559 Menus::Menus() : d(new Impl) {}
2575 void Menus::read(Lexer & lex)
2583 LexerKeyword menutags[] = {
2584 { "end", md_endmenuset },
2585 { "menu", md_menu },
2586 { "menubar", md_menubar }
2589 // consistency check
2590 if (compare_ascii_no_case(lex.getString(), "menuset"))
2591 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
2593 lex.pushTable(menutags);
2594 lex.setContext("Menus::read");
2598 while (lex.isOK() && !quit) {
2599 switch (lex.lex()) {
2601 d->menubar_.read(lex);
2605 QString const name = toqstr(lex.getDocString());
2606 if (d->hasMenu(name))
2607 d->getMenu(name).read(lex);
2609 MenuDefinition menu(name);
2611 d->menulist_.push_back(menu);
2619 lex.printError("Unknown menu tag");
2627 bool Menus::searchMenu(FuncRequest const & func,
2628 docstring_list & names, BufferView const * bv) const
2630 MenuDefinition menu;
2631 d->expand(d->menubar_, menu, bv);
2632 return menu.searchMenu(func, names);
2636 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
2640 // setup special mac specific menu items, but only do this
2641 // the first time a QMenuBar is created. Otherwise Qt will
2642 // create duplicate items in the application menu. It seems
2643 // that Qt does not remove them when the QMenubar is cleared.
2644 d->macxMenuBarInit(qmb);
2647 // Clear all menubar contents before filling it.
2649 #if (QT_VERSION >= 0x050000 && defined(Q_OS_MAC))
2650 d->macxMenuBarInit(qmb);
2654 LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
2656 if (d->menubar_.empty()) {
2657 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
2658 << d->menubar_.name());
2661 LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
2663 MenuDefinition menu;
2664 BufferView * bv = 0;
2666 bv = view->currentBufferView();
2667 d->expand(d->menubar_, menu, bv);
2669 MenuDefinition::const_iterator m = menu.begin();
2670 MenuDefinition::const_iterator end = menu.end();
2672 for (; m != end; ++m) {
2674 if (m->kind() != MenuItem::Submenu) {
2675 LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
2679 LYXERR(Debug::GUI, "menu bar item " << m->label()
2680 << " is a submenu named " << m->submenuname());
2682 QString name = m->submenuname();
2683 if (!d->hasMenu(name)) {
2684 LYXERR(Debug::GUI, "\tERROR: " << name
2685 << " submenu has no menu!");
2689 Menu * menuptr = new Menu(view, m->submenuname(), true);
2690 menuptr->setTitle(label(*m));
2692 #if defined(Q_OS_MAC) && (defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
2693 // On Mac OS with QT/cocoa, the menu is not displayed if there is no action
2694 // so we create a temporary one here
2695 QAction * action = new QAction(menuptr);
2696 menuptr->addAction(action);
2699 qmb->addMenu(menuptr);
2701 d->name_map_[view][name] = menuptr;
2706 void Menus::updateMenu(Menu * qmenu)
2708 LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
2711 if (qmenu->d->name.isEmpty())
2714 docstring identifier = qstring_to_ucs4(qmenu->d->name);
2715 MenuDefinition fromLyxMenu(qmenu->d->name);
2716 while (!identifier.empty()) {
2717 docstring menu_name;
2718 identifier = split(identifier, menu_name, ';');
2720 if (!d->hasMenu(toqstr(menu_name))) {
2721 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
2726 MenuDefinition cat_menu = d->getMenu(toqstr(menu_name));
2727 //FIXME: 50 is a wild guess. We should take into account here
2728 //the expansion of menu items, disabled optional items etc.
2729 bool const in_sub_menu = !fromLyxMenu.empty()
2730 && fromLyxMenu.size() + cat_menu.size() > 50 ;
2732 fromLyxMenu.catSub(menu_name);
2734 fromLyxMenu.cat(cat_menu);
2735 fromLyxMenu.add(MenuItem(MenuItem::Separator));
2738 if (fromLyxMenu.empty()) {
2739 qmenu->addAction(qt_("No Action Defined!"));
2743 BufferView * bv = 0;
2745 bv = qmenu->d->view->currentBufferView();
2746 d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
2747 qmenu->d->populate(qmenu, *qmenu->d->top_level_menu);
2751 Menu * Menus::menu(QString const & name, GuiView & view, bool keyboard)
2753 LYXERR(Debug::GUI, "Context menu requested: " << name);
2754 Menu * menu = d->name_map_[&view].value(name, 0);
2755 if (!menu && !name.startsWith("context-")) {
2756 LYXERR0("requested context menu not found: " << name);
2760 menu = new Menu(&view, name, true, keyboard);
2761 d->name_map_[&view][name] = menu;
2765 } // namespace frontend
2768 #include "moc_Menus.cpp"