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"
79 #include <QProxyStyle>
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 exports the document default format
139 typically for the File->Export menu. */
141 /** This is a list of importable formats
142 typically for the File->Import menu. */
144 /** This is the list of elements available
145 * for insertion into document. */
147 /** This is the list of user-configurable
148 insets to insert into 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 arguments for a given info inset */
175 /** Available graphics groups */
177 /// Words suggested by the spellchecker.
179 /** Used Languages */
181 /** This is the list of arguments available
182 for insertion into the current layout. */
184 /** This is the list of arguments available
185 in the InsetArgument context menu. */
187 /** This is the list of captions available
188 in the current layout. */
190 /** This is the list of captions available
191 in the InsetCaption context menu. */
193 /** Commands to separate environments. */
194 EnvironmentSeparators,
195 /** Commands to separate environments (context menu version). */
196 EnvironmentSeparatorsContext,
197 /** This is the list of quotation marks available */
199 /** Options in the Zoom menu **/
203 explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
206 QString const & label,
207 QString const & submenu = QString(),
208 QString const & tooltip = QString(),
209 bool optional = false)
210 : kind_(kind), label_(label), func_(make_shared<FuncRequest>()),
211 submenuname_(submenu), tooltip_(tooltip), optional_(optional)
213 LATTEST(kind == Submenu || kind == Help || kind == Info);
217 QString const & label,
218 FuncRequest const & func,
219 QString const & tooltip = QString(),
220 bool optional = false,
221 FuncRequest::Origin origin = FuncRequest::MENU)
222 : kind_(kind), label_(label), func_(make_shared<FuncRequest>(func)),
223 tooltip_(tooltip), optional_(optional)
225 func_->setOrigin(origin);
228 /// The label of a given menuitem
229 QString label() const
231 int const index = label_.lastIndexOf('|');
232 return index == -1 ? label_ : label_.left(index);
235 /// The keyboard shortcut (usually underlined in the entry)
236 QString shortcut() const
238 int const index = label_.lastIndexOf('|');
239 return index == -1 ? QString() : label_.mid(index + 1);
241 /// The complete label, with label and shortcut separated by a '|'
242 QString fulllabel() const { return label_; }
243 /// The kind of entry
244 Kind kind() const { return kind_; }
245 /// the action (if relevant)
246 shared_ptr<FuncRequest const> func() const { return func_; }
248 QString const & tooltip() const { return tooltip_; }
249 /// returns true if the entry should be omitted when disabled
250 bool optional() const { return optional_; }
251 /// returns the status of the lfun associated with this entry
252 FuncStatus const & status() const { return status_; }
253 /// returns the status of the lfun associated with this entry
254 FuncStatus & status() { return status_; }
255 /// returns the status of the lfun associated with this entry
256 void status(FuncStatus const & status) { status_ = status; }
258 ///returns the binding associated to this action.
259 QString binding() const
261 if (kind_ != Command)
263 // Get the keys bound to this action, but keep only the
265 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(*func_);
266 if (!bindings.empty())
267 return toqstr(bindings.begin()->print(KeySequence::ForGui));
269 LYXERR(Debug::KBMAP, "No binding for "
270 << lyxaction.getActionName(func_->action())
271 << '(' << func_->argument() << ')');
275 /// the description of the submenu (if relevant)
276 QString const & submenuname() const { return submenuname_; }
277 /// set the description of the submenu
278 void submenuname(QString const & name) { submenuname_ = name; }
280 bool hasSubmenu() const { return !submenu_.isEmpty(); }
282 MenuDefinition const & submenu() const { return submenu_.at(0); }
283 MenuDefinition & submenu() { return submenu_[0]; }
285 void setSubmenu(MenuDefinition const & menu)
288 submenu_.append(menu);
297 shared_ptr<FuncRequest> func_;// non-null
299 QString submenuname_;
306 /// contains 0 or 1 item.
307 QList<MenuDefinition> submenu_;
311 class MenuDefinition {
314 typedef std::vector<MenuItem> ItemList;
316 typedef ItemList::const_iterator const_iterator;
318 explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
323 QString const & name() const { return name_; }
325 bool empty() const { return items_.empty(); }
326 /// Clear the menu content.
327 void clear() { items_.clear(); }
329 size_t size() const { return items_.size(); }
331 const_iterator begin() const { return items_.begin(); }
333 const_iterator end() const { return items_.end(); }
335 void cat(MenuDefinition const & other);
337 void catSub(docstring const & name);
339 // search for func in this menu iteratively, and put menu
341 bool searchMenu(FuncRequest const & func, docstring_list & names)
344 bool hasFunc(FuncRequest const &) const;
345 /// Add the menu item unconditionally
346 void add(MenuItem const & item) { items_.push_back(item); }
347 /// Checks the associated FuncRequest status before adding the
349 void addWithStatusCheck(MenuItem const &);
350 // Check whether the menu shortcuts are unique
351 void checkShortcuts() const;
353 void expandLastfiles();
354 void expandDocuments();
355 void expandBookmarks();
356 void expandFormats(MenuItem::Kind const kind, Buffer const * buf);
357 void expandFloatListInsert(Buffer const * buf);
358 void expandFloatInsert(Buffer const * buf);
359 void expandFlexInsert(Buffer const * buf, InsetLyXType type);
360 void expandTocSubmenu(std::string const & type, Toc const & toc_list);
361 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth, const string & toc_type);
362 void expandToc(Buffer const * buf);
363 void expandPasteRecent(Buffer const * buf);
364 void expandToolbars();
365 void expandBranches(Buffer const * buf);
366 void expandIndices(Buffer const * buf, bool listof = false);
367 void expandIndicesContext(Buffer const * buf, bool listof = false);
368 void expandCiteStyles(BufferView const *);
369 void expandInfoArguments(BufferView const *);
370 void expandGraphicsGroups(BufferView const *);
371 void expandSpellingSuggestions(BufferView const *);
372 void expandLanguageSelector(Buffer const * buf);
373 void expandArguments(BufferView const *, bool switcharg = false);
374 void expandCaptions(Buffer const * buf, bool switchcap = false);
375 void expandEnvironmentSeparators(BufferView const *, bool contextmenu = false);
376 void expandQuotes(BufferView const *);
377 void expandZoomOptions(BufferView const *);
385 /// Helper for std::find_if
389 MenuNamesEqual(QString const & name) : name_(name) {}
390 bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
397 typedef std::vector<MenuDefinition> MenuList;
399 typedef MenuList::const_iterator const_iterator;
401 typedef MenuList::iterator iterator;
403 /////////////////////////////////////////////////////////////////////
404 // MenuDefinition implementation
405 /////////////////////////////////////////////////////////////////////
407 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
411 case MenuItem::Command: {
412 FuncStatus status = lyx::getStatus(*i.func());
413 if (status.unknown() || (!status.enabled() && i.optional()))
416 items_.back().status(status);
420 case MenuItem::Submenu: {
421 bool enabled = false;
422 if (i.hasSubmenu()) {
423 for (const_iterator cit = i.submenu().begin();
424 cit != i.submenu().end(); ++cit) {
425 // Only these kind of items affect the status of the submenu
426 if ((cit->kind() == MenuItem::Command
427 || cit->kind() == MenuItem::Submenu
428 || cit->kind() == MenuItem::Help)
429 && cit->status().enabled()) {
435 if (enabled || !i.optional()) {
437 items_.back().status().setEnabled(enabled);
442 case MenuItem::Separator:
443 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
453 void MenuDefinition::read(Lexer & lex)
470 md_indiceslistscontext,
485 md_spellingsuggestions,
492 md_env_separatorscontext,
497 LexerKeyword menutags[] = {
498 { "arguments", md_arguments },
499 { "bookmarks", md_bookmarks },
500 { "branches", md_branches },
501 { "captions", md_captions },
502 { "charstyles", md_charstyles },
503 { "citestyles", md_citestyles },
504 { "custom", md_custom },
505 { "documents", md_documents },
506 { "end", md_endmenu },
507 { "environmentseparators", md_env_separators },
508 { "environmentseparatorscontext", md_env_separatorscontext },
509 { "exportformat", md_exportformat },
510 { "exportformats", md_exportformats },
511 { "floatinsert", md_floatinsert },
512 { "floatlistinsert", md_floatlistinsert },
513 { "graphicsgroups", md_graphicsgroups },
514 { "importformats", md_importformats },
515 { "indices", md_indices },
516 { "indicescontext", md_indicescontext },
517 { "indiceslists", md_indiceslists },
518 { "indiceslistscontext", md_indiceslistscontext },
519 { "infoarguments", md_infoarguments },
521 { "languageselector", md_languageselector },
522 { "lastfiles", md_lastfiles },
523 { "optitem", md_optitem },
524 { "optsubmenu", md_optsubmenu },
525 { "pasterecent", md_pasterecent },
526 { "separator", md_separator },
527 { "spellingsuggestions", md_spellingsuggestions },
528 { "submenu", md_submenu },
529 { "switcharguments", md_switcharguments },
530 { "switchcaptions", md_switchcaptions },
531 { "switchquotes", md_switchquotes },
533 { "toolbars", md_toolbars },
534 { "updateformats", md_updateformats },
535 { "viewformats", md_viewformats },
536 { "zoomoptions", md_zoomoptions }
539 lex.pushTable(menutags);
540 lex.setContext("MenuDefinition::read: ");
543 while (lex.isOK() && md_type != md_endmenu) {
544 switch (md_type = lex.lex()) {
548 docstring const name = translateIfPossible(lex.getDocString());
550 string const command = lex.getString();
551 FuncRequest func = lyxaction.lookupFunc(command);
552 FuncRequest::Origin origin = FuncRequest::MENU;
553 if (name_.startsWith("context-toc-"))
554 origin = FuncRequest::TOC;
555 bool const optional = (md_type == md_optitem);
556 add(MenuItem(MenuItem::Command, toqstr(name), func, QString(), optional, origin));
561 add(MenuItem(MenuItem::Separator));
565 add(MenuItem(MenuItem::Lastfiles));
569 add(MenuItem(MenuItem::CharStyles));
573 add(MenuItem(MenuItem::Custom));
577 add(MenuItem(MenuItem::Documents));
581 add(MenuItem(MenuItem::Bookmarks));
585 add(MenuItem(MenuItem::Toc));
589 add(MenuItem(MenuItem::ViewFormats));
592 case md_updateformats:
593 add(MenuItem(MenuItem::UpdateFormats));
596 case md_exportformats:
597 add(MenuItem(MenuItem::ExportFormats));
600 case md_exportformat:
601 add(MenuItem(MenuItem::ExportFormat));
604 case md_importformats:
605 add(MenuItem(MenuItem::ImportFormats));
608 case md_floatlistinsert:
609 add(MenuItem(MenuItem::FloatListInsert));
613 add(MenuItem(MenuItem::FloatInsert));
617 add(MenuItem(MenuItem::PasteRecent));
621 add(MenuItem(MenuItem::Toolbars));
625 add(MenuItem(MenuItem::Branches));
629 add(MenuItem(MenuItem::CiteStyles));
632 case md_infoarguments:
633 add(MenuItem(MenuItem::InfoArguments));
637 case md_graphicsgroups:
638 add(MenuItem(MenuItem::GraphicsGroups));
641 case md_spellingsuggestions:
642 add(MenuItem(MenuItem::SpellingSuggestions));
645 case md_languageselector:
646 add(MenuItem(MenuItem::LanguageSelector));
650 add(MenuItem(MenuItem::Indices));
653 case md_indicescontext:
654 add(MenuItem(MenuItem::IndicesContext));
657 case md_indiceslists:
658 add(MenuItem(MenuItem::IndicesLists));
661 case md_indiceslistscontext:
662 add(MenuItem(MenuItem::IndicesListsContext));
666 add(MenuItem(MenuItem::Arguments));
669 case md_switcharguments:
670 add(MenuItem(MenuItem::SwitchArguments));
674 add(MenuItem(MenuItem::Captions));
677 case md_switchcaptions:
678 add(MenuItem(MenuItem::SwitchCaptions));
681 case md_env_separators:
682 add(MenuItem(MenuItem::EnvironmentSeparators));
685 case md_env_separatorscontext:
686 add(MenuItem(MenuItem::EnvironmentSeparatorsContext));
689 case md_switchquotes:
690 add(MenuItem(MenuItem::SwitchQuotes));
694 add(MenuItem(MenuItem::ZoomOptions));
700 docstring const mlabel = translateIfPossible(lex.getDocString());
702 docstring const mname = lex.getDocString();
703 bool const optional = (md_type == md_optsubmenu);
704 add(MenuItem(MenuItem::Submenu,
705 toqstr(mlabel), toqstr(mname), QString(), optional));
713 lex.printError("Unknown menu tag");
721 bool MenuDefinition::hasFunc(FuncRequest const & func) const
723 for (auto const & it : *this)
724 if (*it.func() == func)
730 void MenuDefinition::catSub(docstring const & name)
732 add(MenuItem(MenuItem::Submenu,
733 qt_("More...|M"), toqstr(name), QString(), false));
736 void MenuDefinition::cat(MenuDefinition const & other)
738 const_iterator et = other.end();
739 for (const_iterator it = other.begin(); it != et; ++it)
744 void MenuDefinition::checkShortcuts() const
746 // This is a quadratic algorithm, but we do not care because
747 // menus are short enough
748 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
749 QString shortcut = it1->shortcut();
750 if (shortcut.isEmpty())
752 if (!it1->label().contains(shortcut))
753 LYXERR0("Menu warning: menu entry \""
755 << "\" does not contain shortcut `"
756 << shortcut << "'.");
757 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
758 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
759 LYXERR0("Menu warning: menu entries "
760 << '"' << it1->fulllabel()
761 << "\" and \"" << it2->fulllabel()
762 << "\" share the same shortcut.");
769 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
771 const_iterator m = begin();
772 const_iterator m_end = end();
773 for (; m != m_end; ++m) {
774 if (m->kind() == MenuItem::Command && *m->func() == func) {
775 names.push_back(qstring_to_ucs4(m->label()));
778 if (m->kind() == MenuItem::Submenu) {
779 names.push_back(qstring_to_ucs4(m->label()));
780 if (!m->hasSubmenu()) {
781 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
782 << m->label() << " name=" << m->submenuname());
786 if (m->submenu().searchMenu(func, names))
795 QString limitStringLength(docstring const & str)
797 size_t const max_item_length = 45;
798 docstring ret = str.substr(0, max_item_length + 1);
799 support::truncateWithEllipsis(ret, max_item_length);
804 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
809 graphics::getGraphicsGroups(bv->buffer(), grp);
813 set<string>::const_iterator it = grp.begin();
814 set<string>::const_iterator end = grp.end();
815 add(MenuItem(MenuItem::Command, qt_("No Group"),
816 FuncRequest(LFUN_GRAPHICS_SET_GROUP)));
817 for (; it != end; ++it) {
818 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it) + '|',
819 FuncRequest(LFUN_GRAPHICS_SET_GROUP, *it)));
824 void MenuDefinition::expandSpellingSuggestions(BufferView const * bv)
828 Cursor const & cur = bv->cursor();
832 docstring_list suggestions;
833 Paragraph const & par = cur.paragraph();
834 pos_type from = cur.pos();
836 SpellChecker::Result res = par.spellCheck(from, to, wl, suggestions, true, true);
838 case SpellChecker::UNKNOWN_WORD:
839 if (lyxrc.spellcheck_continuously) {
840 LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
841 docstring const & selection = cur.selectionAsString(false);
842 if (!cur.selection() || selection == wl.word()) {
844 size_t m = 10; // first submenu index
845 MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
846 item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
847 for (; i != suggestions.size(); ++i) {
848 docstring const & suggestion = suggestions[i];
849 LYXERR(Debug::GUI, suggestion);
850 MenuItem w(MenuItem::Command, toqstr(suggestion),
851 FuncRequest(LFUN_WORD_REPLACE,
852 replace2string(suggestion, selection,
853 true, // case sensitive
859 false))); // only selection
863 item.submenu().add(w);
868 add(MenuItem(MenuItem::Separator));
869 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
870 add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|n"),
871 FuncRequest(LFUN_SPELLING_ADD, arg)));
872 add(MenuItem(MenuItem::Command, qt_("Ignore this occurrence|g"),
873 FuncRequest(LFUN_FONT_NO_SPELLCHECK, arg)));
874 add(MenuItem(MenuItem::Command, qt_("Ignore all for this session|I"),
875 FuncRequest(LFUN_SPELLING_IGNORE, arg)));
876 add(MenuItem(MenuItem::Command, qt_("Ignore all in this document|d"),
877 FuncRequest(LFUN_SPELLING_ADD_LOCAL, arg)));
881 case SpellChecker::LEARNED_WORD: {
882 LYXERR(Debug::GUI, "Learned Word.");
883 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
884 add(MenuItem(MenuItem::Command, qt_("Remove from personal dictionary|r"),
885 FuncRequest(LFUN_SPELLING_REMOVE, arg)));
888 case SpellChecker::DOCUMENT_LEARNED_WORD: {
889 LYXERR(Debug::GUI, "Document-Learned Word.");
890 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
891 add(MenuItem(MenuItem::Command, qt_("Remove from document dictionary|r"),
892 FuncRequest(LFUN_SPELLING_REMOVE_LOCAL, arg)));
895 case SpellChecker::NO_DICTIONARY:
896 LYXERR(Debug::GUI, "No dictionary for language " + from_ascii(wl.lang()->lang()));
898 case SpellChecker::WORD_OK:
899 case SpellChecker::COMPOUND_WORD:
900 case SpellChecker::ROOT_FOUND:
901 case SpellChecker::IGNORED_WORD:
906 struct sortLanguageByName {
907 bool operator()(const Language * a, const Language * b) const {
908 return qt_(a->display()).localeAwareCompare(qt_(b->display())) < 0;
912 void MenuDefinition::expandLanguageSelector(Buffer const * buf)
917 std::set<Language const *> languages_buffer =
918 buf->masterBuffer()->getLanguages();
920 if (languages_buffer.size() < 2) {
921 add(MenuItem(MenuItem::Command, qt_("Switch Language...|L"),
922 FuncRequest(LFUN_DIALOG_SHOW, "character")));
926 std::set<Language const *, sortLanguageByName> langs;
928 std::set<Language const *>::const_iterator const beg =
929 languages_buffer.begin();
930 for (std::set<Language const *>::const_iterator cit = beg;
931 cit != languages_buffer.end(); ++cit) {
935 MenuItem item(MenuItem::Submenu, qt_("Language|L"));
936 item.setSubmenu(MenuDefinition(qt_("Language")));
937 QString morelangs = qt_("More Languages ...|M");
938 QStringList accelerators;
939 if (morelangs.contains('|'))
940 accelerators.append(morelangs.section('|', -1));
941 std::set<Language const *, sortLanguageByName>::const_iterator const begin = langs.begin();
942 for (std::set<Language const *, sortLanguageByName>::const_iterator cit = begin;
943 cit != langs.end(); ++cit) {
944 QString label = qt_((*cit)->display());
945 // try to add an accelerator
946 bool success = false;
947 // try capitals first
948 for (int i = 0; i < label.size(); ++i) {
949 QChar const ch = label[i];
952 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
953 label = label + toqstr("|") + ch;
954 accelerators.append(ch);
959 // if all capitals are taken, try the rest
961 for (int i = 0; i < label.size(); ++i) {
962 if (label[i].isSpace())
964 QString const ch = QString(label[i]);
965 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
966 label = label + toqstr("|") + ch;
967 accelerators.append(ch);
972 MenuItem w(MenuItem::Command, label,
973 FuncRequest(LFUN_LANGUAGE, (*cit)->lang() + " set"));
974 item.submenu().addWithStatusCheck(w);
976 item.submenu().add(MenuItem(MenuItem::Separator));
977 item.submenu().add(MenuItem(MenuItem::Command, morelangs,
978 FuncRequest(LFUN_DIALOG_SHOW, "character")));
983 void MenuDefinition::expandLastfiles()
985 LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
986 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
990 for (; lfit != lf.end() && ii <= lyxrc.num_lastfiles; ++lfit, ++ii) {
991 string const file = lfit->absFileName();
992 QString const short_path = toqstr(makeDisplayPath(file, 30));
993 QString const long_path = toqstr(makeDisplayPath(file));
996 label = QString("%1. %2|%3").arg(ii).arg(short_path).arg(ii);
998 label = QString("%1. %2").arg(ii).arg(short_path);
999 add(MenuItem(MenuItem::Command, label,
1000 FuncRequest(LFUN_FILE_OPEN, file), long_path));
1005 void MenuDefinition::expandDocuments()
1007 MenuItem item(MenuItem::Submenu, qt_("Hidden|H"));
1008 item.setSubmenu(MenuDefinition(qt_("Hidden|H")));
1010 Buffer * const first = theBufferList().first();
1012 add(MenuItem(MenuItem::Info, qt_("(No Documents Open)")));
1018 if (!guiApp->currentView())
1020 GuiWorkArea * wa = guiApp->currentView()->workArea(i);
1023 Buffer const & b = wa->bufferView().buffer();
1024 QString label = toqstr(b.fileName().displayName(20));
1027 if (b.notifiesExternalModification())
1028 label += QChar(0x26a0); // warning sign ⚠
1030 label = QString::number(i) + ". " + label + '|' + QString::number(i);
1031 add(MenuItem(MenuItem::Command, label,
1032 FuncRequest(LFUN_BUFFER_SWITCH, b.absFileName())));
1039 // We cannot use a for loop as the buffer list cycles.
1041 if (!(guiApp->currentView()
1042 && guiApp->currentView()->workArea(*b))) {
1043 QString label = toqstr(b->fileName().displayName(20));
1046 if (b->notifiesExternalModification())
1047 label += QChar(0x26a0);
1049 label = QString::number(i) + ". " + label + '|' + QString::number(i);
1050 item.submenu().add(MenuItem(MenuItem::Command, label,
1051 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
1054 b = theBufferList().next(b);
1055 } while (b != first);
1057 if (!item.submenu().empty())
1062 void MenuDefinition::expandBookmarks()
1064 lyx::BookmarksSection const & bm = theSession().bookmarks();
1067 for (size_t i = 1; i <= bm.size(); ++i) {
1068 if (bm.isValid(i)) {
1069 string const file = bm.bookmark(i).filename.absFileName();
1070 QString const label = QString("%1. %2|%3").arg(i)
1071 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
1072 add(MenuItem(MenuItem::Command, label,
1073 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
1078 add(MenuItem(MenuItem::Info, qt_("(No Bookmarks Saved Yet)")));
1082 void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf)
1084 if (!buf && kind != MenuItem::ImportFormats)
1088 FuncCode action = LFUN_NOACTION;
1091 case MenuItem::ImportFormats:
1092 formats = theConverters().importableFormats();
1093 action = LFUN_BUFFER_IMPORT;
1095 case MenuItem::ViewFormats:
1096 formats = buf->params().exportableFormats(true);
1097 action = LFUN_BUFFER_VIEW;
1099 case MenuItem::UpdateFormats:
1100 formats = buf->params().exportableFormats(true);
1101 action = LFUN_BUFFER_UPDATE;
1103 case MenuItem::ExportFormats:
1104 formats = buf->params().exportableFormats(false);
1105 action = LFUN_BUFFER_EXPORT;
1112 bool const view_update = (kind == MenuItem::ViewFormats
1113 || kind == MenuItem::UpdateFormats);
1117 smenue = (kind == MenuItem::ViewFormats
1118 ? qt_("View (Other Formats)|F")
1119 : qt_("Update (Other Formats)|p"));
1120 MenuItem item(MenuItem::Submenu, smenue);
1121 item.setSubmenu(MenuDefinition(smenue));
1123 for (Format const * f : formats) {
1127 docstring lab = f->prettyname();
1128 docstring const scut = from_utf8(f->shortcut());
1129 docstring const tmplab = lab;
1132 lab += char_type('|') + scut;
1133 docstring const lab_i18n = translateIfPossible(lab);
1134 docstring const shortcut = split(lab_i18n, lab, '|');
1136 bool const untranslated = (lab == lab_i18n);
1137 docstring label = untranslated ? translateIfPossible(tmplab) : lab;
1140 case MenuItem::ImportFormats:
1143 label += from_ascii("...");
1145 case MenuItem::ViewFormats:
1146 case MenuItem::UpdateFormats:
1147 if (f->name() == buf->params().getDefaultOutputFormat()) {
1148 docstring lbl = (kind == MenuItem::ViewFormats
1149 ? bformat(_("View [%1$s]|V"), label)
1150 : bformat(_("Update [%1$s]|U"), label));
1151 add(MenuItem(MenuItem::Command, toqstr(lbl), FuncRequest(action)));
1155 case MenuItem::ExportFormats:
1156 if (!f->inExportMenu())
1160 // we already asserted earlier in this case
1164 if (!shortcut.empty())
1165 label += '|' + shortcut;
1168 // note that at this point, we know that buf is not null
1170 item.submenu().addWithStatusCheck(MenuItem(MenuItem::Command,
1171 toqstr(label), FuncRequest(action, f->name())));
1174 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1175 FuncRequest(action, f->name())));
1177 add(MenuItem(MenuItem::Command, toqstr(label),
1178 FuncRequest(action, f->name())));
1186 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
1191 FloatList const & floats = buf->params().documentClass().floats();
1192 FloatList::const_iterator cit = floats.begin();
1193 FloatList::const_iterator end = floats.end();
1195 for (; cit != end; ++cit) {
1196 if (!cit->second.usesFloatPkg()) {
1197 // Different floats could declare the same ListCommand. We only
1198 // want it on the list once, though.
1199 string const & list_cmd = cit->second.listCommand();
1200 if (list_cmd.empty())
1201 // we do not know how to generate such a list
1203 // This form of insert returns an iterator pointing to the newly
1204 // inserted element OR the existing element with that value, and
1205 // a bool indicating whether we inserted a new element. So we can
1206 // see if one is there and insert it if not all at once.
1207 pair<set<string>::iterator, bool> ret = seen.insert(list_cmd);
1211 string const & list_name = cit->second.listName();
1212 addWithStatusCheck(MenuItem(MenuItem::Command, qt_(list_name),
1213 FuncRequest(LFUN_FLOAT_LIST_INSERT, cit->second.floattype())));
1218 void MenuDefinition::expandFloatInsert(Buffer const * buf)
1223 FloatList const & floats = buf->params().documentClass().floats();
1224 FloatList::const_iterator cit = floats.begin();
1225 FloatList::const_iterator end = floats.end();
1226 for (; cit != end; ++cit) {
1228 if (cit->second.name().empty())
1230 QString const label = qt_(cit->second.name());
1231 addWithStatusCheck(MenuItem(MenuItem::Command, label,
1232 FuncRequest(LFUN_FLOAT_INSERT,
1233 cit->second.floattype())));
1238 void MenuDefinition::expandFlexInsert(
1239 Buffer const * buf, InsetLyXType type)
1244 TextClass::InsetLayouts const & insetLayouts =
1245 buf->params().documentClass().insetLayouts();
1246 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
1247 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
1248 for (; cit != end; ++cit) {
1249 if (cit->second.lyxtype() == type) {
1250 if (!cit->second.obsoleted_by().empty())
1252 docstring name = cit->first;
1253 // we remove the "Flex:" prefix, if it is present
1254 if (prefixIs(name, from_ascii("Flex:")))
1255 name = name.substr(5);
1256 docstring const label = (cit->second.menustring().empty()) ?
1258 : cit->second.menustring();
1259 addWithStatusCheck(MenuItem(MenuItem::Command,
1260 toqstr(translateIfPossible(label)),
1261 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(name))));
1264 // FIXME This is a little clunky.
1265 if (items_.empty() && type == InsetLyXType::CUSTOM && !buf->hasReadonlyFlag())
1266 add(MenuItem(MenuItem::Help, qt_("(No Custom Insets Defined)")));
1270 // Threshold before we stop displaying sub-items alongside items
1271 // (for display purposes). Ideally this should fit on a screen.
1272 size_t const max_number_of_items = 30;
1273 // Size limit for the menu. This is for performance purposes,
1274 // because qt already displays a scrollable menu when necessary.
1275 // Ideally this should be the menu size from which scrollable
1276 // menus become unpractical.
1277 size_t const menu_size_limit = 80;
1279 void MenuDefinition::expandToc2(Toc const & toc_list,
1280 size_t from, size_t to, int depth,
1281 string const & toc_type)
1283 int shortcut_count = 0;
1285 // check whether depth is smaller than the smallest depth in toc.
1286 int min_depth = 1000;
1287 for (size_t i = from; i < to; ++i)
1288 min_depth = min(min_depth, toc_list[i].depth());
1289 if (min_depth > depth)
1292 if (to - from <= max_number_of_items) {
1293 for (size_t i = from; i < to; ++i) {
1294 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
1295 label += limitStringLength(toc_list[i].asString());
1296 if (toc_list[i].depth() == depth) {
1298 if (shortcut_count < 9) {
1299 if (label.contains(QString::number(shortcut_count + 1)))
1300 label += QString::number(++shortcut_count);
1303 add(MenuItem(MenuItem::Command, label, toc_list[i].action()));
1304 // separator after the menu heading
1305 if (toc_list[i].depth() < depth)
1306 add(MenuItem(MenuItem::Separator));
1312 size_t new_pos = pos + 1;
1313 while (new_pos < to && toc_list[new_pos].depth() > depth)
1316 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
1317 label += limitStringLength(toc_list[pos].asString());
1318 if (toc_list[pos].depth() == depth) {
1320 if (shortcut_count < 9) {
1321 if (label.contains(QString::number(shortcut_count + 1)))
1322 label += QString::number(++shortcut_count);
1325 if (size >= menu_size_limit) {
1326 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + toc_type);
1327 add(MenuItem(MenuItem::Command, "...", f));
1330 if (new_pos == pos + 1) {
1331 add(MenuItem(MenuItem::Command, label, toc_list[pos].action()));
1334 sub.expandToc2(toc_list, pos, new_pos, depth + 1, toc_type);
1335 MenuItem item(MenuItem::Submenu, label);
1336 item.setSubmenu(sub);
1346 void MenuDefinition::expandToc(Buffer const * buf)
1348 // To make things very cleanly, we would have to pass buf to
1349 // all MenuItem constructors and to expandToc2. However, we
1350 // know that all the entries in a TOC will be have status_ ==
1351 // OK, so we avoid this unnecessary overhead (JMarc)
1353 add(MenuItem(MenuItem::Info, qt_("(No Document Open)")));
1356 // Add an entry for the master doc if this is a child doc
1357 Buffer const * const master = buf->masterBuffer();
1358 if (buf != master) {
1359 ParIterator const pit = par_iterator_begin(master->inset());
1360 string const arg = convert<string>(pit->id());
1361 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
1362 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
1365 MenuDefinition other_lists;
1366 // In the navigation menu, only add tocs from this document
1367 TocBackend const & backend = buf->tocBackend();
1368 TocList const & toc_list = backend.tocs();
1369 for (pair<const string, shared_ptr<Toc>> const & toc : toc_list) {
1370 // Handle table of contents later
1371 if (toc.first == "tableofcontents" || toc.second->empty())
1373 MenuDefinition submenu;
1374 submenu.expandTocSubmenu(toc.first, *toc.second);
1375 docstring const toc_name = backend.outlinerName(toc.first);
1376 MenuItem item(MenuItem::Submenu, toqstr(toc_name));
1377 item.setSubmenu(submenu);
1378 // deserves to be in the main menu?
1379 if (!TocBackend::isOther(toc.first))
1382 other_lists.add(item);
1384 if (!other_lists.empty()) {
1385 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
1386 item.setSubmenu(other_lists);
1389 // Handle normal TOC
1390 add(MenuItem(MenuItem::Separator));
1391 TocList::const_iterator const cit = toc_list.find("tableofcontents");
1392 if (cit == toc_list.end())
1393 LYXERR(Debug::GUI, "No table of contents.");
1395 if (!cit->second->empty())
1396 expandToc2(*cit->second, 0, cit->second->size(), 0,
1399 add(MenuItem(MenuItem::Info, qt_("(Empty Table of Contents)")));
1404 void MenuDefinition::expandTocSubmenu(std::string const & type, Toc const & toc)
1406 // "Open outliner..." entry
1407 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + type);
1408 add(MenuItem(MenuItem::Command, qt_("Open Outliner..."), f));
1409 add(MenuItem(MenuItem::Separator));
1411 expandToc2(toc, 0, toc.size(), 0, type);
1415 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1417 docstring_list const sel = cap::availableSelections(buf);
1419 docstring_list::const_iterator cit = sel.begin();
1420 docstring_list::const_iterator end = sel.end();
1422 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1423 add(MenuItem(MenuItem::Command, toqstr(*cit) + '|',
1424 FuncRequest(LFUN_PASTE, convert<string>(index))));
1429 void MenuDefinition::expandToolbars()
1431 MenuDefinition other_lists;
1432 // extracts the toolbars from the backend
1433 Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1434 Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1435 for (; cit != end; ++cit) {
1436 MenuItem item(MenuItem::Command, toqstr(cit->gui_name),
1437 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1438 if (cit->allow_auto) {
1439 MenuDefinition tristate;
1440 tristate.add(MenuItem(MenuItem::Command, qt_("[[Toolbar]]On|O"),
1441 FuncRequest(LFUN_TOOLBAR_SET, cit->name + " on")));
1442 tristate.add(MenuItem(MenuItem::Command, qt_("[[Toolbar]]Off|f"),
1443 FuncRequest(LFUN_TOOLBAR_SET, cit->name + " off")));
1444 tristate.add(MenuItem(MenuItem::Command, qt_("[[Toolbar]]Automatic|A"),
1445 FuncRequest(LFUN_TOOLBAR_SET, cit->name + " auto")));
1446 item = MenuItem(MenuItem::Submenu,toqstr(cit->gui_name));
1447 item.setSubmenu(tristate);
1449 if (guiApp->toolbars().isMainToolbar(cit->name))
1452 other_lists.add(item);
1455 if (!other_lists.empty()) {
1456 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1457 item.setSubmenu(other_lists);
1463 void MenuDefinition::expandBranches(Buffer const * buf)
1465 if (!buf || buf->hasReadonlyFlag())
1468 BranchList const & child_list = buf->params().branchlist();
1469 set<docstring> brset;
1471 for (auto const & b : child_list) {
1472 docstring const & bname = b.branch();
1473 // NUM. Branch Name + "|", which triggers an empty shortcut in
1474 // case that character should be in the branch name.
1475 docstring label = convert<docstring>(ii) + ". " + bname + char_type('|');
1476 // Add NUM as a keyboard shortcut if it's a single digit
1478 label += convert<docstring>(ii);
1480 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1481 FuncRequest(LFUN_BRANCH_INSERT, bname)));
1483 brset.insert(bname);
1487 set<Buffer const *> bufset;
1488 Buffer const * nextbuf = buf->parent();
1489 MenuDefinition master_branches;
1492 // recursive includes are a bad idea, but let's not crash
1494 if (bufset.count(nextbuf))
1497 for (auto const & b : nextbuf->params().branchlist()) {
1498 docstring const & bname = b.branch();
1499 // do not add it if we've already seen it
1500 if (brset.count(bname))
1503 docstring label = convert<docstring>(ii) + ". " + bname + char_type('|');
1505 label += convert<docstring>(ii);
1507 master_branches.addWithStatusCheck(MenuItem(MenuItem::Command,
1508 toqstr(label), FuncRequest(LFUN_BRANCH_INSERT, bname)));
1510 bufset.insert(nextbuf);
1511 brset.insert(bname);
1515 nextbuf = nextbuf->parent();
1518 if (!master_branches.empty()) {
1519 MenuItem item(MenuItem::Submenu, qt_("Master Documents"));
1520 item.setSubmenu(master_branches);
1526 void MenuDefinition::expandIndices(Buffer const * buf, bool listof)
1531 BufferParams const & params = buf->masterBuffer()->params();
1532 if (!params.use_indices) {
1534 addWithStatusCheck(MenuItem(MenuItem::Command,
1535 qt_("Index List|I"),
1536 FuncRequest(LFUN_INDEX_PRINT,
1537 from_ascii("idx"))));
1539 addWithStatusCheck(MenuItem(MenuItem::Command,
1540 qt_("Index Entry|d"),
1541 FuncRequest(LFUN_INDEX_INSERT,
1542 from_ascii("idx"))));
1546 if (params.indiceslist().empty())
1549 IndicesList::const_iterator cit = params.indiceslist().begin();
1550 IndicesList::const_iterator end = params.indiceslist().end();
1552 for (int ii = 1; cit != end; ++cit, ++ii) {
1554 docstring const label =
1555 bformat(_("Index: %1$s"), cit->index());
1556 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1557 FuncRequest(LFUN_INDEX_PRINT, cit->shortcut())));
1559 docstring const label =
1560 bformat(_("Index Entry (%1$s)"), cit->index());
1561 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1562 FuncRequest(LFUN_INDEX_INSERT, cit->shortcut())));
1568 void MenuDefinition::expandIndicesContext(Buffer const * buf, bool listof)
1573 BufferParams const & params = buf->masterBuffer()->params();
1574 if (!params.use_indices || params.indiceslist().empty())
1577 IndicesList::const_iterator cit = params.indiceslist().begin();
1578 IndicesList::const_iterator end = params.indiceslist().end();
1580 for (int ii = 1; cit != end; ++cit, ++ii) {
1582 InsetCommandParams p(INDEX_PRINT_CODE);
1583 p["type"] = cit->shortcut();
1584 string const data = InsetCommand::params2string(p);
1585 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
1586 FuncRequest(LFUN_INSET_MODIFY, data)));
1588 docstring const label =
1589 bformat(_("Index Entry (%1$s)"), cit->index());
1590 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1591 FuncRequest(LFUN_INSET_MODIFY,
1592 from_ascii("changetype ") + cit->shortcut())));
1598 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1603 Inset const * inset = bv->cursor().nextInset();
1604 if (!inset || inset->lyxCode() != CITE_CODE) {
1605 add(MenuItem(MenuItem::Command,
1606 qt_("No Citation in Scope!"),
1607 FuncRequest(LFUN_NOACTION)));
1610 InsetCitation const * citinset =
1611 static_cast<InsetCitation const *>(inset);
1613 Buffer const * buf = &bv->buffer();
1614 BufferParams const & bp = buf->masterParams();
1615 string const cmd = citinset->params().getCmdName();
1617 docstring const & key = citinset->getParam("key");
1619 add(MenuItem(MenuItem::Command,
1620 qt_("No citations selected!"),
1621 FuncRequest(LFUN_NOACTION)));
1625 bool const force = isUpperCase(cmd[0]);
1626 bool const star = suffixIs(cmd, '*');
1628 vector<docstring> const keys = getVectorFromString(key);
1630 vector<CitationStyle> const citeStyleList = bp.citeStyles();
1632 CitationStyle cs = citinset->getCitationStyle(bp, cmd, citeStyleList);
1633 bool const qualified = cs.hasQualifiedList
1635 || !citinset->getParam("pretextlist").empty()
1636 || !citinset->getParam("posttextlist").empty());
1637 vector<pair<docstring, docstring>> pres =
1638 citinset->getQualifiedLists(citinset->getParam("pretextlist"));
1639 vector<pair<docstring, docstring>> posts =
1640 citinset->getQualifiedLists(citinset->getParam("posttextlist"));
1643 ci.textBefore = citinset->getParam("before");
1644 ci.textAfter = citinset->getParam("after");
1645 ci.forceUpperCase = force;
1647 ci.context = CiteItem::Dialog;
1649 ci.isQualified = qualified;
1651 ci.posttexts = posts;
1652 BiblioInfo::CiteStringMap citeStrings =
1653 buf->masterBibInfo().getCiteStrings(keys, citeStyleList, bv->buffer(), ci);
1655 BiblioInfo::CiteStringMap::const_iterator cit = citeStrings.begin();
1656 BiblioInfo::CiteStringMap::const_iterator end = citeStrings.end();
1658 for (int ii = 1; cit != end; ++cit, ++ii) {
1659 docstring label = cit->second;
1660 CitationStyle ccs = citeStyleList[ii - 1];
1661 ccs.forceUpperCase &= force;
1662 ccs.hasStarredVersion &= star;
1663 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1664 FuncRequest(LFUN_INSET_MODIFY,
1665 "changetype " + from_utf8(citationStyleToString(ccs)))));
1668 if (cs.hasStarredVersion) {
1669 docstring starred = _("All authors|h");
1670 // Check if we have a custom string/tooltip for the starred version
1671 if (!cs.stardesc.empty()) {
1673 bp.documentClass().getCiteMacro(buf->params().citeEngineType(), cs.stardesc);
1675 starred = translateIfPossible(from_utf8(val));
1676 // Transform qt-style accelerators to menu-style
1677 int const amps = count_char(starred, '&');
1680 starred = subst(starred, from_ascii("&&"), from_ascii("<:amp:>"));
1681 size_t nn = starred.find('&');
1682 char_type accel = char_type();
1683 if (nn != docstring::npos && nn < starred.size() - 1)
1684 accel = starred[nn + 1];
1685 starred = subst(starred, from_ascii("&"), from_ascii(""));
1687 starred = subst(starred, from_ascii("<:amp:>"), from_ascii("&&"));
1688 if (accel != char_type())
1689 starred = starred + '|' + accel;
1692 add(MenuItem(MenuItem::Separator));
1693 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(starred),
1694 FuncRequest(LFUN_INSET_MODIFY, "toggleparam star")));
1697 if (cs.forceUpperCase) {
1698 if (!cs.hasStarredVersion)
1699 add(MenuItem(MenuItem::Separator));
1700 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(_("Force upper case|u")),
1701 FuncRequest(LFUN_INSET_MODIFY, "toggleparam casing")));
1706 void MenuDefinition::expandInfoArguments(BufferView const * bv)
1711 Inset const * inset = bv->cursor().nextInset();
1712 if (!inset || inset->lyxCode() != INFO_CODE) {
1713 add(MenuItem(MenuItem::Command,
1714 qt_("No Text Field in Scope!"),
1715 FuncRequest(LFUN_NOACTION)));
1718 InsetInfo const * iinset = static_cast<InsetInfo const *>(inset);
1720 string const type = iinset->params().infoType();
1721 vector<pair<string,docstring>> const args =
1722 iinset->params().getArguments(&bv->buffer(), type);
1724 // Don't generate a menu for big lists (such as lfuns and rcs)
1725 if (args.size() > 15)
1728 for (auto const & p : args) {
1729 if (p.first == "invalid")
1732 if (p.first == "custom") {
1733 add(MenuItem(MenuItem::Command, qt_("Custom..."),
1734 FuncRequest(LFUN_INSET_SETTINGS, "info")));
1737 docstring label = p.second;
1738 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1739 FuncRequest(LFUN_INSET_MODIFY, type + " " + p.first)));
1745 void MenuDefinition::expandArguments(BufferView const * bv, bool switcharg)
1750 if (!bv->cursor().inTexted())
1753 Inset const * inset = &bv->cursor().inset();
1754 Layout::LaTeXArgMap args = bv->cursor().paragraph().layout().args();
1755 if (inset && args.empty())
1756 args = inset->getLayout().args();
1757 if (args.empty() || (switcharg && args.size() == 1))
1759 Layout::LaTeXArgMap::const_iterator lait = args.begin();
1760 Layout::LaTeXArgMap::const_iterator const laend = args.end();
1761 for (; lait != laend; ++lait) {
1762 Layout::latexarg arg = (*lait).second;
1763 docstring str = arg.menustring.empty()? arg.labelstring : arg.menustring;
1764 QString item = toqstr(translateIfPossible(str));
1766 add(MenuItem(MenuItem::Command, item,
1767 FuncRequest(LFUN_INSET_MODIFY,
1768 from_ascii("changetype ")
1769 + from_ascii((*lait).first))));
1771 add(MenuItem(MenuItem::Command, item,
1772 FuncRequest(LFUN_ARGUMENT_INSERT,
1773 from_ascii((*lait).first))));
1778 void MenuDefinition::expandCaptions(Buffer const * buf, bool switchcap)
1783 DocumentClass const & dc = buf->params().documentClass();
1784 vector< pair<docstring, FuncRequest> > caps;
1785 for (pair<const docstring, InsetLayout> const & il : dc.insetLayouts()) {
1787 docstring const type = split(il.first, instype, ':');
1788 if (instype == from_ascii("Caption")) {
1789 // skip forbidden caption types
1790 FuncRequest const cmd = switchcap
1791 ? FuncRequest(LFUN_INSET_MODIFY, from_ascii("changetype ") + type)
1792 : FuncRequest(LFUN_CAPTION_INSERT, type);
1793 if (getStatus(cmd).enabled())
1794 caps.push_back(make_pair(type, cmd));
1798 if (caps.empty() || (switchcap && caps.size() == 1))
1800 if (caps.size() == 1) {
1801 add(MenuItem(MenuItem::Command, qt_("Caption"), caps.front().second));
1805 MenuDefinition captions;
1806 for (pair<docstring, FuncRequest> const & cap : caps) {
1807 docstring const type = cap.first;
1808 docstring const trtype = translateIfPossible(type);
1809 docstring const cmitem = bformat(_("Caption (%1$s)"), trtype);
1811 add(MenuItem(MenuItem::Command, toqstr(cmitem), cap.second));
1813 captions.add(MenuItem(MenuItem::Command, toqstr(trtype), cap.second));
1815 if (!captions.empty()) {
1816 MenuItem item(MenuItem::Submenu, qt_("Caption"));
1817 item.setSubmenu(captions);
1823 void MenuDefinition::expandZoomOptions(BufferView const * bv)
1828 add(MenuItem(MenuItem::Command,
1829 toqstr(bformat(_("Reset to Default (%1$d%)|R"),
1830 lyxrc.defaultZoom)),
1831 FuncRequest(LFUN_BUFFER_ZOOM)));
1832 add(MenuItem(MenuItem::Command, qt_("Zoom In|I"),
1833 FuncRequest(LFUN_BUFFER_ZOOM_IN)));
1834 add(MenuItem(MenuItem::Command, qt_("Zoom Out|O"),
1835 FuncRequest(LFUN_BUFFER_ZOOM_OUT)));
1836 add(MenuItem(MenuItem::Separator));
1837 // Offer some fractional values of the default
1838 int z = lyxrc.defaultZoom * 1.75;
1839 add(MenuItem(MenuItem::Command,
1840 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1841 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1842 z = lyxrc.defaultZoom * 1.5;
1843 add(MenuItem(MenuItem::Command,
1844 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1845 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1846 z = lyxrc.defaultZoom * 1.25;
1847 add(MenuItem(MenuItem::Command,
1848 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1849 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1850 z = lyxrc.defaultZoom * 0.75;
1851 add(MenuItem(MenuItem::Command,
1852 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1853 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1854 z = lyxrc.defaultZoom * 0.5;
1855 add(MenuItem(MenuItem::Command,
1856 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1857 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1858 z = lyxrc.defaultZoom * 0.25;
1859 add(MenuItem(MenuItem::Command,
1860 toqstr(bformat(_("[[ZOOM]]%1$d%"), z)),
1861 FuncRequest(LFUN_BUFFER_ZOOM, convert<string>(z))));
1865 void MenuDefinition::expandQuotes(BufferView const * bv)
1870 if (!bv->cursor().inTexted())
1873 Inset const * inset = bv->cursor().nextInset();
1874 if (!inset || inset->lyxCode() != QUOTE_CODE) {
1875 add(MenuItem(MenuItem::Command,
1876 qt_("No Quote in Scope!"),
1877 FuncRequest(LFUN_NOACTION)));
1880 InsetQuotes const * qinset =
1881 static_cast<InsetQuotes const *>(inset);
1883 string const qtype = qinset->getType();
1887 BufferParams const & bp = bv->buffer().masterBuffer()->params();
1889 // The global setting
1890 QuoteStyle globalqs = bp.quotes_style;
1891 char const globalqsc = quoteparams.getStyleChar(globalqs);
1893 // The current language's default
1894 QuoteStyle langdefqs =
1895 bp.getQuoteStyle(bv->cursor().current_font.language()->quoteStyle());
1896 char const langqs = quoteparams.getStyleChar(langdefqs);
1898 bool main_global_qs = false;
1899 bool main_langdef_qs = false;
1900 bool main_dynamic_qs = false;
1901 docstring const subcmd = from_ascii("changetype ");
1902 docstring const wildcards = from_ascii("..");
1904 // First the top level menu (all glyphs of the current style) ...
1905 // Begin with dynamic (if they are current style),
1906 if (qtype[0] == 'x') {
1907 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + from_ascii("xld"));
1908 docstring desc = bformat(_("%1$s (dynamic)"),
1909 quoteparams.getShortGuiLabel(globalqsc + from_ascii("ld")));
1910 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1911 cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + from_ascii("xls"));
1912 desc = bformat(_("%1$s (dynamic)"),
1913 quoteparams.getShortGuiLabel(globalqsc + from_ascii("ls")));
1914 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1915 cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + from_ascii("xrd"));
1916 desc = bformat(_("%1$s (dynamic)"),
1917 quoteparams.getShortGuiLabel(globalqsc + from_ascii("rd")));
1918 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1919 cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + from_ascii("xrs"));
1920 desc = bformat(_("%1$s (dynamic)"),
1921 quoteparams.getShortGuiLabel(globalqsc + from_ascii("rs")));
1922 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1923 main_dynamic_qs = true;
1925 // now traverse through the static styles ...
1926 map<string, docstring> styles = quoteparams.getTypes();
1927 for (auto const & s : styles) {
1928 char style_char = (s.first)[0];
1929 bool langdef = (style_char == langqs);
1930 bool globaldef = (style_char == globalqsc);
1931 docstring const style = from_ascii(s.first);
1933 if (prefixIs(style, qtype[0])) {
1934 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + style);
1935 docstring const desc = quoteparams.getShortGuiLabel(style);
1936 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1937 main_global_qs = globaldef;
1938 main_langdef_qs = langdef;
1940 else if (!langdef && !globaldef && suffixIs(style, from_ascii("ld"))) {
1941 docstring const desc =
1942 quoteparams.getGuiLabel(quoteparams.getQuoteStyle(to_ascii(style)));
1943 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + style[0] + "..");
1944 aqs.add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1948 add(MenuItem(MenuItem::Separator));
1950 bool display_static = false;
1951 // ... then potentially items to reset to the defaults and to dynamic style ...
1952 if (!main_dynamic_qs && globalqsc != 'x') {
1953 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + 'x' + wildcards);
1954 docstring const desc = bformat(_("Use dynamic quotes (%1$s)|d"),
1955 quoteparams.getGuiLabel(globalqs));
1956 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1957 display_static = true;
1959 if (!main_global_qs && langdefqs != globalqs) {
1960 docstring const variant = main_dynamic_qs ? _("dynamic[[Quotes]]") : _("static[[Quotes]]");
1961 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + globalqsc + wildcards);
1962 docstring const desc = bformat(_("Reset to document default (%1$s, %2$s)|o"),
1963 quoteparams.getGuiLabel(globalqs), variant);
1964 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1966 if (!main_langdef_qs) {
1967 FuncRequest cmd = FuncRequest(LFUN_INSET_MODIFY, subcmd + globalqsc + wildcards);
1968 docstring const desc = (main_dynamic_qs || display_static)
1969 ? bformat(_("Reset to language default (%1$s, %2$s)|l"),
1970 quoteparams.getGuiLabel(langdefqs), _("static[[Quotes]]"))
1971 : bformat(_("Reset to language default (%1$s)|l"),
1972 quoteparams.getGuiLabel(langdefqs));
1973 add(MenuItem(MenuItem::Command, toqstr(desc), cmd));
1976 add(MenuItem(MenuItem::Separator));
1978 // ... and a subitem with the rest
1979 MenuItem item(MenuItem::Submenu, qt_("Change Style|y"));
1980 item.setSubmenu(aqs);
1985 void MenuDefinition::expandEnvironmentSeparators(BufferView const * bv,
1990 Text const * text = bv->cursor().text();
1991 // no paragraphs and no separators exist in math
1995 pit_type pit = bv->cursor().selBegin().pit();
1996 Paragraph const & par = text->getPar(pit);
1997 docstring const curlayout = par.layout().name();
1998 docstring outerlayout;
1999 docstring prevlayout;
2000 depth_type current_depth = par.params().depth();
2001 // check if we have an environment in our scope
2006 Paragraph cpar = text->getPar(pit);
2007 if (cpar.layout().isEnvironment() && prevlayout.empty()
2008 && cpar.params().depth() <= current_depth)
2009 prevlayout = cpar.layout().name();
2010 if (cpar.params().depth() < current_depth
2011 && cpar.layout().isEnvironment()) {
2012 outerlayout = cpar.layout().name();
2013 current_depth = cpar.params().depth();
2015 if (cpar.params().depth() == 0)
2018 if (par.layout().isEnvironment()) {
2019 docstring label = contextmenu ?
2020 bformat(_("Insert Separated %1$s Above"),
2021 translateIfPossible(curlayout)) :
2022 bformat(_("Separated %1$s Above"),
2023 translateIfPossible(curlayout));
2024 add(MenuItem(MenuItem::Command, toqstr(label),
2025 FuncRequest(LFUN_ENVIRONMENT_SPLIT,
2026 from_ascii("before"))));
2027 label = contextmenu ?
2028 bformat(_("Insert Separated %1$s Below"),
2029 translateIfPossible(curlayout)):
2030 bformat(_("Separated %1$s Below"),
2031 translateIfPossible(curlayout));
2032 // We use command-alternatives here since this is how the binding is defined
2033 // (otherwise, the binding is not displayed in the menu)
2034 if (getStatus(FuncRequest(LFUN_ENVIRONMENT_SPLIT)).enabled())
2035 add(MenuItem(MenuItem::Command, toqstr(label),
2036 FuncRequest(LFUN_COMMAND_ALTERNATIVES,
2037 from_ascii("environment-split ; environment-split previous"))));
2039 else if (!prevlayout.empty()) {
2040 docstring const label = contextmenu ?
2041 bformat(_("Insert Separated %1$s Below"),
2042 translateIfPossible(prevlayout)) :
2043 bformat(_("Separated %1$s Below"),
2044 translateIfPossible(prevlayout));
2045 // We use command-alternatives here since this is how the binding is defined
2046 // (otherwise, the binding is not displayed in the menu)
2047 if (getStatus(FuncRequest(LFUN_ENVIRONMENT_SPLIT)).enabled())
2048 add(MenuItem(MenuItem::Command, toqstr(label),
2049 FuncRequest(LFUN_COMMAND_ALTERNATIVES,
2050 from_ascii("environment-split ; environment-split previous"))));
2052 if (!outerlayout.empty()) {
2055 label = (outerlayout == curlayout) ?
2056 bformat(_("Insert Separated Outer %1$s Below"),
2057 translateIfPossible(outerlayout)) :
2058 bformat(_("Insert Separated %1$s Below"),
2059 translateIfPossible(outerlayout));
2061 label = (outerlayout == curlayout) ?
2062 bformat(_("Separated Outer %1$s Below"),
2063 translateIfPossible(outerlayout)) :
2064 bformat(_("Separated %1$s Below"),
2065 translateIfPossible(outerlayout));
2067 add(MenuItem(MenuItem::Command, toqstr(label),
2068 FuncRequest(LFUN_ENVIRONMENT_SPLIT,
2069 from_ascii("outer"))));
2076 /////////////////////////////////////////////////////////////////////
2077 // Menu::Impl definition and implementation
2078 /////////////////////////////////////////////////////////////////////
2082 /// populates the menu or one of its submenu
2083 /// This is used as a recursive function
2084 void populate(QMenu * qMenu, MenuDefinition const & menu);
2086 /// Only needed for top level menus.
2087 MenuDefinition * top_level_menu;
2090 /// the name of this menu
2096 /// Get a MenuDefinition item label from the menu backend
2097 static QString label(MenuItem const & mi)
2099 QString label = mi.label();
2100 label.replace("&", "&&");
2102 QString shortcut = mi.shortcut();
2103 if (!shortcut.isEmpty()) {
2104 int pos = label.indexOf(shortcut);
2106 //label.insert(pos, 1, char_type('&'));
2107 label.replace(pos, 0, "&");
2110 QString const binding = mi.binding();
2111 if (!binding.isEmpty())
2112 label += '\t' + binding;
2117 void Menu::Impl::populate(QMenu * qMenu, MenuDefinition const & menu)
2119 LYXERR(Debug::GUI, "populating menu " << menu.name());
2121 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
2124 LYXERR(Debug::GUI, " ***** menu entries " << menu.size());
2125 for (MenuItem const & m : menu)
2127 case MenuItem::Separator:
2128 qMenu->addSeparator();
2130 case MenuItem::Submenu: {
2131 QMenu * subMenu = qMenu->addMenu(label(m));
2132 populate(subMenu, m.submenu());
2133 subMenu->setEnabled(!subMenu->isEmpty());
2136 case MenuItem::Command:
2138 // FIXME: A previous comment assured that MenuItem::Command was the
2139 // only possible case in practice, but this is wrong. It would be
2140 // good to document which cases are actually treated here.
2141 qMenu->addAction(new Action(m.func(), QIcon(), label(m),
2142 m.tooltip(), qMenu));
2147 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN))
2148 class AlwaysMnemonicStyle : public QProxyStyle {
2150 int styleHint(StyleHint hint, const QStyleOption *opt = 0, const QWidget *widget = 0,
2151 QStyleHintReturn *returnData = 0) const override
2153 if (hint == QStyle::SH_UnderlineShortcut)
2155 return QProxyStyle::styleHint(hint, opt, widget, returnData);
2160 /////////////////////////////////////////////////////////////////////
2161 // Menu implementation
2162 /////////////////////////////////////////////////////////////////////
2164 Menu::Menu(GuiView * gv, QString const & name, bool top_level, bool keyboard)
2165 : QMenu(gv), d(new Menu::Impl)
2167 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN))
2169 setStyle(new AlwaysMnemonicStyle);
2173 d->top_level_menu = top_level? new MenuDefinition : 0;
2177 if (d->top_level_menu)
2178 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
2184 delete d->top_level_menu;
2189 void Menu::updateView()
2191 guiApp->menus().updateMenu(this);
2197 QList<QAction *> items = actions();
2198 for (int i = 0; i != items.size(); ++i) {
2199 // QAction::menu() returns 0 if there's no submenu.
2200 delete items.at(i)->menu();
2206 /////////////////////////////////////////////////////////////////////
2207 // Menus::Impl definition and implementation
2208 /////////////////////////////////////////////////////////////////////
2210 struct Menus::Impl {
2212 bool hasMenu(QString const &) const;
2214 MenuDefinition & getMenu(QString const &);
2216 MenuDefinition const & getMenu(QString const &) const;
2218 /// Expands some special entries of the menu
2219 /** The entries with the following kind are expanded to a
2220 sequence of Command MenuItems: Lastfiles, Documents,
2221 ViewFormats, ExportFormats, UpdateFormats, Branches,
2222 Indices, Arguments, SwitchArguments, Captions, SwitchCaptions,
2223 EnvironmentSeparators
2225 void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
2226 BufferView const *) const;
2228 /// Initialize specific MACOS X menubar
2229 void macxMenuBarInit(QMenuBar * qmb);
2231 /// Mac special menu.
2232 /** This defines a menu whose entries list the FuncRequests
2233 that will be removed by expand() in other menus. This is
2234 used by the Qt/Mac code.
2236 NOTE: Qt does not remove the menu items when clearing a QMenuBar,
2237 such that the items will keep accessing the FuncRequests in
2238 the MenuDefinition. While Menus::Impl might be recreated,
2239 we keep mac_special_menu_ in memory by making it static.
2241 static MenuDefinition mac_special_menu_;
2246 MenuDefinition menubar_;
2248 typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
2250 /// name to menu for \c menu() method.
2255 MenuDefinition Menus::Impl::mac_special_menu_;
2259 Here is what the Qt documentation says about how a menubar is chosen:
2261 1) If the window has a QMenuBar then it is used. 2) If the window
2262 is a modal then its menubar is used. If no menubar is specified
2263 then a default menubar is used (as documented below) 3) If the
2264 window has no parent then the default menubar is used (as
2267 The above 3 steps are applied all the way up the parent window
2268 chain until one of the above are satisfied. If all else fails a
2269 default menubar will be created, the default menubar on Qt/Mac is
2270 an empty menubar, however you can create a different default
2271 menubar by creating a parentless QMenuBar, the first one created
2272 will thus be designated the default menubar, and will be used
2273 whenever a default menubar is needed.
2275 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
2276 that this menubar will be used also when one of LyX' dialogs has
2279 void Menus::Impl::macxMenuBarInit(QMenuBar * qmb)
2281 /* The qt/mac menu code has special code for specifying the role
2282 of a menu entry. However, it does not work very well with our
2283 scheme of creating menus on demand, and therefore we need to
2284 put these entries in a special invisible menu. (JMarc)
2287 /* The entries of our special mac menu. If we add support for
2288 * special entries in Menus, we could imagine something
2290 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
2291 * and therefore avoid hardcoding. I am not sure it is worth
2292 * the hassle, though. (JMarc)
2294 struct MacMenuEntry {
2298 QAction::MenuRole role;
2301 static const MacMenuEntry entries[] = {
2302 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
2303 QAction::AboutRole},
2304 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
2305 QAction::PreferencesRole},
2306 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
2308 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
2309 const bool first_call = mac_special_menu_.empty();
2311 LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
2312 // the special menu for Menus. Fill it up only once.
2314 for (size_t i = 0 ; i < num_entries ; ++i) {
2315 FuncRequest const func(entries[i].action,
2316 from_utf8(entries[i].arg));
2317 mac_special_menu_.add(MenuItem(MenuItem::Command,
2318 entries[i].label, func));
2322 // add the entries to a QMenu that will eventually be empty
2323 // and therefore invisible.
2324 QMenu * qMenu = qmb->addMenu("special");
2326 for (MenuItem const & m : mac_special_menu_) {
2327 Action * action = new Action(m.func(), QIcon(), m.label(),
2329 action->setMenuRole(entries[i].role);
2330 qMenu->addAction(action);
2336 void Menus::Impl::expand(MenuDefinition const & frommenu,
2337 MenuDefinition & tomenu, BufferView const * bv) const
2339 if (!tomenu.empty())
2342 for (MenuDefinition::const_iterator cit = frommenu.begin();
2343 cit != frommenu.end() ; ++cit) {
2344 Buffer const * buf = bv ? &bv->buffer() : 0;
2345 switch (cit->kind()) {
2346 case MenuItem::Lastfiles:
2347 tomenu.expandLastfiles();
2350 case MenuItem::Documents:
2351 tomenu.expandDocuments();
2354 case MenuItem::Bookmarks:
2355 tomenu.expandBookmarks();
2358 case MenuItem::ImportFormats:
2359 case MenuItem::ViewFormats:
2360 case MenuItem::UpdateFormats:
2361 case MenuItem::ExportFormats:
2362 tomenu.expandFormats(cit->kind(), buf);
2365 case MenuItem::ExportFormat: {
2368 string const format = buf->params().getDefaultOutputFormat();
2369 Format const * f = theFormats().getFormat(format);
2370 docstring const name = f ? translateIfPossible(f->prettyname())
2371 : from_utf8(format);
2372 docstring const label = bformat(_("Export [%1$s]|E"), name);
2373 MenuItem item(MenuItem::Command, toqstr(label),
2374 FuncRequest(LFUN_BUFFER_EXPORT));
2375 tomenu.addWithStatusCheck(item);
2379 case MenuItem::CharStyles:
2380 tomenu.expandFlexInsert(buf, InsetLyXType::CHARSTYLE);
2383 case MenuItem::Custom:
2384 tomenu.expandFlexInsert(buf, InsetLyXType::CUSTOM);
2387 case MenuItem::FloatListInsert:
2388 tomenu.expandFloatListInsert(buf);
2391 case MenuItem::FloatInsert:
2392 tomenu.expandFloatInsert(buf);
2395 case MenuItem::PasteRecent:
2396 tomenu.expandPasteRecent(buf);
2399 case MenuItem::Toolbars:
2400 tomenu.expandToolbars();
2403 case MenuItem::Branches:
2404 tomenu.expandBranches(buf);
2407 case MenuItem::Indices:
2408 tomenu.expandIndices(buf);
2411 case MenuItem::IndicesContext:
2412 tomenu.expandIndicesContext(buf);
2415 case MenuItem::IndicesLists:
2416 tomenu.expandIndices(buf, true);
2419 case MenuItem::IndicesListsContext:
2420 tomenu.expandIndicesContext(buf, true);
2423 case MenuItem::CiteStyles:
2424 tomenu.expandCiteStyles(bv);
2427 case MenuItem::InfoArguments:
2428 tomenu.expandInfoArguments(bv);
2433 tomenu.expandToc(buf);
2436 case MenuItem::GraphicsGroups:
2437 tomenu.expandGraphicsGroups(bv);
2440 case MenuItem::SpellingSuggestions:
2441 tomenu.expandSpellingSuggestions(bv);
2444 case MenuItem::LanguageSelector:
2445 tomenu.expandLanguageSelector(buf);
2448 case MenuItem::Arguments:
2449 tomenu.expandArguments(bv, false);
2452 case MenuItem::SwitchArguments:
2453 tomenu.expandArguments(bv, true);
2456 case MenuItem::Captions:
2457 tomenu.expandCaptions(buf, false);
2460 case MenuItem::SwitchCaptions:
2461 tomenu.expandCaptions(buf, true);
2464 case MenuItem::EnvironmentSeparators:
2465 tomenu.expandEnvironmentSeparators(bv);
2468 case MenuItem::EnvironmentSeparatorsContext:
2469 tomenu.expandEnvironmentSeparators(bv, true);
2472 case MenuItem::SwitchQuotes:
2473 tomenu.expandQuotes(bv);
2476 case MenuItem::ZoomOptions:
2477 tomenu.expandZoomOptions(bv);
2480 case MenuItem::Submenu: {
2481 MenuItem item(*cit);
2482 item.setSubmenu(MenuDefinition(cit->submenuname()));
2483 expand(getMenu(cit->submenuname()), item.submenu(), bv);
2484 tomenu.addWithStatusCheck(item);
2488 case MenuItem::Info:
2489 case MenuItem::Help:
2490 case MenuItem::Separator:
2491 tomenu.addWithStatusCheck(*cit);
2494 case MenuItem::Command:
2495 if (!mac_special_menu_.hasFunc(*cit->func()))
2496 tomenu.addWithStatusCheck(*cit);
2500 // we do not want the menu to end with a separator
2501 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
2502 tomenu.items_.pop_back();
2504 // Check whether the shortcuts are unique
2505 tomenu.checkShortcuts();
2509 bool Menus::Impl::hasMenu(QString const & name) const
2511 return find_if(menulist_.begin(), menulist_.end(),
2512 MenuNamesEqual(name)) != menulist_.end();
2516 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
2518 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
2519 MenuNamesEqual(name));
2520 if (cit == menulist_.end()) {
2521 LYXERR0("No submenu named " << name);
2522 LASSERT(false, { static const MenuDefinition m; return m; });
2528 MenuDefinition & Menus::Impl::getMenu(QString const & name)
2530 iterator it = find_if(menulist_.begin(), menulist_.end(),
2531 MenuNamesEqual(name));
2532 if (it == menulist_.end()) {
2533 LYXERR0("No submenu named " << name);
2534 LASSERT(false, { static MenuDefinition m; return m; });
2540 /////////////////////////////////////////////////////////////////////
2544 /////////////////////////////////////////////////////////////////////
2546 Menus::Menus() : d(new Impl) {}
2562 void Menus::read(Lexer & lex)
2570 LexerKeyword menutags[] = {
2571 { "end", md_endmenuset },
2572 { "menu", md_menu },
2573 { "menubar", md_menubar }
2576 // consistency check
2577 if (compare_ascii_no_case(lex.getString(), "menuset"))
2578 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
2580 lex.pushTable(menutags);
2581 lex.setContext("Menus::read");
2585 while (lex.isOK() && !quit) {
2586 switch (lex.lex()) {
2588 d->menubar_.read(lex);
2592 QString const name = toqstr(lex.getDocString());
2593 if (d->hasMenu(name))
2594 d->getMenu(name).read(lex);
2596 MenuDefinition menu(name);
2598 d->menulist_.push_back(menu);
2606 lex.printError("Unknown menu tag");
2614 bool Menus::searchMenu(FuncRequest const & func,
2615 docstring_list & names, BufferView const * bv) const
2617 MenuDefinition menu;
2618 d->expand(d->menubar_, menu, bv);
2619 return menu.searchMenu(func, names);
2623 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
2627 // setup special mac specific menu items, but only do this
2628 // the first time a QMenuBar is created. Otherwise Qt will
2629 // create duplicate items in the application menu. It seems
2630 // that Qt does not remove them when the QMenubar is cleared.
2631 d->macxMenuBarInit(qmb);
2634 // Clear all menubar contents before filling it.
2636 #if (defined(Q_OS_MAC))
2637 d->macxMenuBarInit(qmb);
2641 LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
2643 if (d->menubar_.empty()) {
2644 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
2645 << d->menubar_.name());
2648 LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
2650 MenuDefinition menu;
2651 BufferView * bv = 0;
2653 bv = view->currentBufferView();
2654 d->expand(d->menubar_, menu, bv);
2656 MenuDefinition::const_iterator m = menu.begin();
2657 MenuDefinition::const_iterator end = menu.end();
2659 for (; m != end; ++m) {
2661 if (m->kind() != MenuItem::Submenu) {
2662 LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
2666 LYXERR(Debug::GUI, "menu bar item " << m->label()
2667 << " is a submenu named " << m->submenuname());
2669 QString name = m->submenuname();
2670 if (!d->hasMenu(name)) {
2671 LYXERR(Debug::GUI, "\tERROR: " << name
2672 << " submenu has no menu!");
2676 Menu * menuptr = new Menu(view, m->submenuname(), true);
2677 menuptr->setTitle(label(*m));
2679 #if defined(Q_OS_MAC)
2680 // On Mac OS with Qt/Cocoa, the menu is not displayed if there is no action
2681 // so we create a temporary one here
2682 QAction * action = new QAction(menuptr);
2683 menuptr->addAction(action);
2686 qmb->addMenu(menuptr);
2688 d->name_map_[view][name] = menuptr;
2693 void Menus::updateMenu(Menu * qmenu)
2695 LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
2698 if (qmenu->d->name.isEmpty())
2701 docstring identifier = qstring_to_ucs4(qmenu->d->name);
2702 MenuDefinition fromLyxMenu(qmenu->d->name);
2703 while (!identifier.empty()) {
2704 docstring menu_name;
2705 identifier = split(identifier, menu_name, ';');
2707 if (!d->hasMenu(toqstr(menu_name))) {
2708 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
2713 MenuDefinition cat_menu = d->getMenu(toqstr(menu_name));
2714 //FIXME: 50 is a wild guess. We should take into account here
2715 //the expansion of menu items, disabled optional items etc.
2716 bool const in_sub_menu = !fromLyxMenu.empty()
2717 && fromLyxMenu.size() + cat_menu.size() > 50 ;
2719 fromLyxMenu.catSub(menu_name);
2721 fromLyxMenu.cat(cat_menu);
2722 fromLyxMenu.add(MenuItem(MenuItem::Separator));
2725 if (fromLyxMenu.empty()) {
2726 qmenu->addAction(qt_("No Action Defined!"));
2730 BufferView * bv = 0;
2732 bv = qmenu->d->view->currentBufferView();
2733 d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
2734 qmenu->d->populate(qmenu, *qmenu->d->top_level_menu);
2738 Menu * Menus::menu(QString const & name, GuiView & view, bool keyboard)
2740 LYXERR(Debug::GUI, "Context menu requested: " << name);
2741 Menu * menu = d->name_map_[&view].value(name, 0);
2742 if (!menu && !name.startsWith("context-")) {
2743 LYXERR0("requested context menu not found: " << name);
2747 menu = new Menu(&view, name, true, keyboard);
2748 d->name_map_[&view][name] = menu;
2752 } // namespace frontend
2755 #include "moc_Menus.cpp"