3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup
8 * \author Lars Gullik Bjønnes
9 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Martin Vermeer
14 * Full author contact details are available in file CREDITS.
22 #include "GuiApplication.h"
24 #include "GuiWorkArea.h"
25 #include "qt_helpers.h"
27 #include "BiblioInfo.h"
28 #include "BranchList.h"
30 #include "BufferList.h"
31 #include "BufferParams.h"
32 #include "BufferView.h"
33 #include "Converter.h"
34 #include "CutAndPaste.h"
36 #include "FloatList.h"
38 #include "FuncRequest.h"
39 #include "FuncStatus.h"
40 #include "IndicesList.h"
45 #include "LyXAction.h"
49 #include "Paragraph.h"
50 #include "ParagraphParameters.h"
51 #include "ParIterator.h"
53 #include "SpellChecker.h"
54 #include "TextClass.h"
56 #include "TocBackend.h"
58 #include "WordLangTuple.h"
60 #include "insets/Inset.h"
61 #include "insets/InsetCitation.h"
62 #include "insets/InsetGraphics.h"
64 #include "support/lassert.h"
65 #include "support/convert.h"
66 #include "support/debug.h"
67 #include "support/docstring_list.h"
68 #include "support/filetools.h"
69 #include "support/gettext.h"
70 #include "support/lstrings.h"
77 #if QT_VERSION >= 0x040600
78 #include <QProxyStyle>
86 using namespace lyx::support;
94 // MacOSX specific stuff is at the end.
101 /// The type of elements that can be in a menu
109 /** This type of item explains why something is unavailable. If this
110 menuitem is in a submenu, the submenu is enabled to make sure the
111 user sees the information. */
113 /** This type of item merely shows that there might be a list or
114 something alike at this position, but the list is still empty.
115 If this item is in a submenu, the submenu will not always be
118 /** This is the list of last opened file,
119 typically for the File menu. */
121 /** This is the list of opened Documents,
122 typically for the Documents menu. */
124 /** This is the bookmarks */
128 /** This is a list of viewable formats
129 typically for the File->View menu. */
131 /** This is a list of updatable formats
132 typically for the File->Update menu. */
134 /** This is a list of exportable formats
135 typically for the File->Export menu. */
137 /** This is a list of importable formats
138 typically for the File->Import menu. */
140 /** This is the list of elements available
141 * for insertion into document. */
143 /** This is the list of user-configurable
144 insets to insert into document */
146 /** This is the list of XML elements to
147 insert into the document */
149 /** This is the list of floats that we can
150 insert a list for. */
152 /** This is the list of floats that we can
155 /** This is the list of selections that can
160 /** Available branches in document */
162 /** Available indices in document */
164 /** Context menu for indices in document */
166 /** Available index lists in document */
168 /** Context menu for available indices lists in document */
170 /** Available citation styles for a given citation */
172 /** Available graphics groups */
174 /// Words suggested by the spellchecker.
176 /** Used Languages */
178 /** This is the list of arguments available
179 for insertion into the current layout. */
181 /** This is the list of arguments available
182 in the InsetArgument context menu. */
184 /** This is the list of captions available
185 in the current layout. */
187 /** This is the list of captions available
188 in the InsetCaption context menu. */
190 /** Commands to separate environments. */
191 EnvironmentSeparators
194 explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
197 QString const & label,
198 QString const & submenu = QString(),
199 QString const & tooltip = QString(),
200 bool optional = false)
201 : kind_(kind), label_(label), func_(make_shared<FuncRequest>()),
202 submenuname_(submenu), tooltip_(tooltip), optional_(optional)
204 LATTEST(kind == Submenu || kind == Help || kind == Info);
208 QString const & label,
209 FuncRequest const & func,
210 QString const & tooltip = QString(),
211 bool optional = false,
212 FuncRequest::Origin origin = FuncRequest::MENU)
213 : kind_(kind), label_(label), func_(make_shared<FuncRequest>(func)),
214 tooltip_(tooltip), optional_(optional)
216 func_->setOrigin(origin);
219 /// The label of a given menuitem
220 QString label() const
222 int const index = label_.lastIndexOf('|');
223 return index == -1 ? label_ : label_.left(index);
226 /// The keyboard shortcut (usually underlined in the entry)
227 QString shortcut() const
229 int const index = label_.lastIndexOf('|');
230 return index == -1 ? QString() : label_.mid(index + 1);
232 /// The complete label, with label and shortcut separated by a '|'
233 QString fulllabel() const { return label_; }
234 /// The kind of entry
235 Kind kind() const { return kind_; }
236 /// the action (if relevant)
237 shared_ptr<FuncRequest const> func() const { return func_; }
239 QString const & tooltip() const { return tooltip_; }
240 /// returns true if the entry should be omitted when disabled
241 bool optional() const { return optional_; }
242 /// returns the status of the lfun associated with this entry
243 FuncStatus const & status() const { return status_; }
244 /// returns the status of the lfun associated with this entry
245 FuncStatus & status() { return status_; }
246 /// returns the status of the lfun associated with this entry
247 void status(FuncStatus const & status) { status_ = status; }
249 ///returns the binding associated to this action.
250 QString binding() const
252 if (kind_ != Command)
254 // Get the keys bound to this action, but keep only the
256 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(*func_);
257 if (!bindings.empty())
258 return toqstr(bindings.begin()->print(KeySequence::ForGui));
260 LYXERR(Debug::KBMAP, "No binding for "
261 << lyxaction.getActionName(func_->action())
262 << '(' << func_->argument() << ')');
266 /// the description of the submenu (if relevant)
267 QString const & submenuname() const { return submenuname_; }
268 /// set the description of the submenu
269 void submenuname(QString const & name) { submenuname_ = name; }
271 bool hasSubmenu() const { return !submenu_.isEmpty(); }
273 MenuDefinition const & submenu() const { return submenu_.at(0); }
274 MenuDefinition & submenu() { return submenu_[0]; }
276 void setSubmenu(MenuDefinition const & menu)
279 submenu_.append(menu);
288 shared_ptr<FuncRequest> func_;// non-null
290 QString submenuname_;
297 /// contains 0 or 1 item.
298 QList<MenuDefinition> submenu_;
302 class MenuDefinition {
305 typedef std::vector<MenuItem> ItemList;
307 typedef ItemList::const_iterator const_iterator;
309 explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
314 QString const & name() const { return name_; }
316 bool empty() const { return items_.empty(); }
317 /// Clear the menu content.
318 void clear() { items_.clear(); }
320 size_t size() const { return items_.size(); }
322 MenuItem const & operator[](size_t) const;
324 const_iterator begin() const { return items_.begin(); }
326 const_iterator end() const { return items_.end(); }
328 void cat(MenuDefinition const & other);
330 void catSub(docstring const & name);
332 // search for func in this menu iteratively, and put menu
334 bool searchMenu(FuncRequest const & func, docstring_list & names)
337 bool hasFunc(FuncRequest const &) const;
338 /// Add the menu item unconditionally
339 void add(MenuItem const & item) { items_.push_back(item); }
340 /// Checks the associated FuncRequest status before adding the
342 void addWithStatusCheck(MenuItem const &);
343 // Check whether the menu shortcuts are unique
344 void checkShortcuts() const;
346 void expandLastfiles();
347 void expandDocuments();
348 void expandBookmarks();
349 void expandFormats(MenuItem::Kind const kind, Buffer const * buf);
350 void expandFloatListInsert(Buffer const * buf);
351 void expandFloatInsert(Buffer const * buf);
352 void expandFlexInsert(Buffer const * buf, InsetLayout::InsetLyXType type);
353 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth, string toc_type);
354 void expandToc(Buffer const * buf);
355 void expandPasteRecent(Buffer const * buf);
356 void expandToolbars();
357 void expandBranches(Buffer const * buf);
358 void expandIndices(Buffer const * buf, bool listof = false);
359 void expandIndicesContext(Buffer const * buf, bool listof = false);
360 void expandCiteStyles(BufferView const *);
361 void expandGraphicsGroups(BufferView const *);
362 void expandSpellingSuggestions(BufferView const *);
363 void expandLanguageSelector(Buffer const * buf);
364 void expandArguments(BufferView const *, bool switcharg = false);
365 void expandCaptions(Buffer const * buf, bool switchcap = false);
366 void expandEnvironmentSeparators(BufferView const *);
374 /// Helper for std::find_if
378 MenuNamesEqual(QString const & name) : name_(name) {}
379 bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
386 typedef std::vector<MenuDefinition> MenuList;
388 typedef MenuList::const_iterator const_iterator;
390 typedef MenuList::iterator iterator;
392 /////////////////////////////////////////////////////////////////////
393 // MenuDefinition implementation
394 /////////////////////////////////////////////////////////////////////
396 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
400 case MenuItem::Command: {
401 FuncStatus status = lyx::getStatus(*i.func());
402 if (status.unknown() || (!status.enabled() && i.optional()))
405 items_.back().status(status);
409 case MenuItem::Submenu: {
410 bool enabled = false;
411 if (i.hasSubmenu()) {
412 for (const_iterator cit = i.submenu().begin();
413 cit != i.submenu().end(); ++cit) {
414 // Only these kind of items affect the status of the submenu
415 if ((cit->kind() == MenuItem::Command
416 || cit->kind() == MenuItem::Submenu
417 || cit->kind() == MenuItem::Help)
418 && cit->status().enabled()) {
424 if (enabled || !i.optional()) {
426 items_.back().status().setEnabled(enabled);
431 case MenuItem::Separator:
432 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
442 void MenuDefinition::read(Lexer & lex)
459 md_indiceslistscontext,
473 md_spellingsuggestions,
482 LexerKeyword menutags[] = {
483 { "arguments", md_arguments },
484 { "bookmarks", md_bookmarks },
485 { "branches", md_branches },
486 { "captions", md_captions },
487 { "charstyles", md_charstyles },
488 { "citestyles", md_citestyles },
489 { "custom", md_custom },
490 { "documents", md_documents },
491 { "elements", md_elements },
492 { "end", md_endmenu },
493 { "environmentseparators", md_env_separators },
494 { "exportformats", md_exportformats },
495 { "floatinsert", md_floatinsert },
496 { "floatlistinsert", md_floatlistinsert },
497 { "graphicsgroups", md_graphicsgroups },
498 { "importformats", md_importformats },
499 { "indices", md_indices },
500 { "indicescontext", md_indicescontext },
501 { "indiceslists", md_indiceslists },
502 { "indiceslistscontext", md_indiceslistscontext },
504 { "languageselector", md_languageselector },
505 { "lastfiles", md_lastfiles },
506 { "optitem", md_optitem },
507 { "optsubmenu", md_optsubmenu },
508 { "pasterecent", md_pasterecent },
509 { "separator", md_separator },
510 { "spellingsuggestions", md_spellingsuggestions },
511 { "submenu", md_submenu },
512 { "switcharguments", md_switcharguments },
513 { "switchcaptions", md_switchcaptions },
515 { "toolbars", md_toolbars },
516 { "updateformats", md_updateformats },
517 { "viewformats", md_viewformats }
520 lex.pushTable(menutags);
521 lex.setContext("MenuDefinition::read: ");
524 while (lex.isOK() && md_type != md_endmenu) {
525 switch (md_type = lex.lex()) {
529 docstring const name = translateIfPossible(lex.getDocString());
531 string const command = lex.getString();
532 FuncRequest func = lyxaction.lookupFunc(command);
533 FuncRequest::Origin origin = FuncRequest::MENU;
534 if (name_.startsWith("context-toc-"))
535 origin = FuncRequest::TOC;
536 bool const optional = (md_type == md_optitem);
537 add(MenuItem(MenuItem::Command, toqstr(name), func, QString(), optional, origin));
542 add(MenuItem(MenuItem::Separator));
546 add(MenuItem(MenuItem::Lastfiles));
550 add(MenuItem(MenuItem::CharStyles));
554 add(MenuItem(MenuItem::Custom));
558 add(MenuItem(MenuItem::Elements));
562 add(MenuItem(MenuItem::Documents));
566 add(MenuItem(MenuItem::Bookmarks));
570 add(MenuItem(MenuItem::Toc));
574 add(MenuItem(MenuItem::ViewFormats));
577 case md_updateformats:
578 add(MenuItem(MenuItem::UpdateFormats));
581 case md_exportformats:
582 add(MenuItem(MenuItem::ExportFormats));
585 case md_importformats:
586 add(MenuItem(MenuItem::ImportFormats));
589 case md_floatlistinsert:
590 add(MenuItem(MenuItem::FloatListInsert));
594 add(MenuItem(MenuItem::FloatInsert));
598 add(MenuItem(MenuItem::PasteRecent));
602 add(MenuItem(MenuItem::Toolbars));
606 add(MenuItem(MenuItem::Branches));
610 add(MenuItem(MenuItem::CiteStyles));
613 case md_graphicsgroups:
614 add(MenuItem(MenuItem::GraphicsGroups));
617 case md_spellingsuggestions:
618 add(MenuItem(MenuItem::SpellingSuggestions));
621 case md_languageselector:
622 add(MenuItem(MenuItem::LanguageSelector));
626 add(MenuItem(MenuItem::Indices));
629 case md_indicescontext:
630 add(MenuItem(MenuItem::IndicesContext));
633 case md_indiceslists:
634 add(MenuItem(MenuItem::IndicesLists));
637 case md_indiceslistscontext:
638 add(MenuItem(MenuItem::IndicesListsContext));
642 add(MenuItem(MenuItem::Arguments));
645 case md_switcharguments:
646 add(MenuItem(MenuItem::SwitchArguments));
650 add(MenuItem(MenuItem::Captions));
653 case md_switchcaptions:
654 add(MenuItem(MenuItem::SwitchCaptions));
657 case md_env_separators:
658 add(MenuItem(MenuItem::EnvironmentSeparators));
664 docstring const mlabel = translateIfPossible(lex.getDocString());
666 docstring const mname = lex.getDocString();
667 bool const optional = (md_type == md_optsubmenu);
668 add(MenuItem(MenuItem::Submenu,
669 toqstr(mlabel), toqstr(mname), QString(), optional));
677 lex.printError("Unknown menu tag");
685 MenuItem const & MenuDefinition::operator[](size_type i) const
691 bool MenuDefinition::hasFunc(FuncRequest const & func) const
693 for (const_iterator it = begin(), et = end(); it != et; ++it)
694 if (*it->func() == func)
700 void MenuDefinition::catSub(docstring const & name)
702 add(MenuItem(MenuItem::Submenu,
703 qt_("More...|M"), toqstr(name), QString(), false));
706 void MenuDefinition::cat(MenuDefinition const & other)
708 const_iterator et = other.end();
709 for (const_iterator it = other.begin(); it != et; ++it)
714 void MenuDefinition::checkShortcuts() const
716 // This is a quadratic algorithm, but we do not care because
717 // menus are short enough
718 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
719 QString shortcut = it1->shortcut();
720 if (shortcut.isEmpty())
722 if (!it1->label().contains(shortcut))
723 LYXERR0("Menu warning: menu entry \""
725 << "\" does not contain shortcut `"
726 << shortcut << "'.");
727 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
728 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
729 LYXERR0("Menu warning: menu entries "
730 << '"' << it1->fulllabel()
731 << "\" and \"" << it2->fulllabel()
732 << "\" share the same shortcut.");
739 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
741 const_iterator m = begin();
742 const_iterator m_end = end();
743 for (; m != m_end; ++m) {
744 if (m->kind() == MenuItem::Command && *m->func() == func) {
745 names.push_back(qstring_to_ucs4(m->label()));
748 if (m->kind() == MenuItem::Submenu) {
749 names.push_back(qstring_to_ucs4(m->label()));
750 if (!m->hasSubmenu()) {
751 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
752 << m->label() << " name=" << m->submenuname());
756 if (m->submenu().searchMenu(func, names))
765 QString limitStringLength(docstring const & str)
767 size_t const max_item_length = 45;
768 docstring ret = str.substr(0, max_item_length + 1);
769 support::truncateWithEllipsis(ret, max_item_length);
774 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
779 graphics::getGraphicsGroups(bv->buffer(), grp);
783 set<string>::const_iterator it = grp.begin();
784 set<string>::const_iterator end = grp.end();
785 add(MenuItem(MenuItem::Command, qt_("No Group"),
786 FuncRequest(LFUN_SET_GRAPHICS_GROUP)));
787 for (; it != end; ++it) {
788 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it) + '|',
789 FuncRequest(LFUN_SET_GRAPHICS_GROUP, *it)));
794 void MenuDefinition::expandSpellingSuggestions(BufferView const * bv)
798 Cursor const & cur = bv->cursor();
802 docstring_list suggestions;
803 Paragraph const & par = cur.paragraph();
804 pos_type from = cur.pos();
806 SpellChecker::Result res = par.spellCheck(from, to, wl, suggestions, true, true);
808 case SpellChecker::UNKNOWN_WORD:
809 if (lyxrc.spellcheck_continuously) {
810 LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
811 docstring const & selection = cur.selectionAsString(false);
812 if (!cur.selection() || selection == wl.word()) {
814 size_t m = 10; // first submenu index
815 MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
816 item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
817 for (; i != suggestions.size(); ++i) {
818 docstring const & suggestion = suggestions[i];
819 LYXERR(Debug::GUI, suggestion);
820 MenuItem w(MenuItem::Command, toqstr(suggestion),
821 FuncRequest(LFUN_WORD_REPLACE,
822 replace2string(suggestion, selection,
823 true, // case sensitive
827 false))); // find next
831 item.submenu().add(w);
836 add(MenuItem(MenuItem::Separator));
837 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
838 add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|n"),
839 FuncRequest(LFUN_SPELLING_ADD, arg)));
840 add(MenuItem(MenuItem::Command, qt_("Ignore all|I"),
841 FuncRequest(LFUN_SPELLING_IGNORE, arg)));
845 case SpellChecker::LEARNED_WORD: {
846 LYXERR(Debug::GUI, "Learned Word.");
847 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
848 add(MenuItem(MenuItem::Command, qt_("Remove from personal dictionary|r"),
849 FuncRequest(LFUN_SPELLING_REMOVE, arg)));
852 case SpellChecker::NO_DICTIONARY:
853 LYXERR(Debug::GUI, "No dictionary for language " + from_ascii(wl.lang()->lang()));
855 case SpellChecker::WORD_OK:
856 case SpellChecker::COMPOUND_WORD:
857 case SpellChecker::ROOT_FOUND:
858 case SpellChecker::IGNORED_WORD:
863 struct sortLanguageByName {
864 bool operator()(const Language * a, const Language * b) const {
865 return qt_(a->display()).localeAwareCompare(qt_(b->display())) < 0;
869 void MenuDefinition::expandLanguageSelector(Buffer const * buf)
874 std::set<Language const *> languages_buffer =
875 buf->masterBuffer()->getLanguages();
877 if (languages_buffer.size() < 2)
880 std::set<Language const *, sortLanguageByName> languages;
882 std::set<Language const *>::const_iterator const beg =
883 languages_buffer.begin();
884 for (std::set<Language const *>::const_iterator cit = beg;
885 cit != languages_buffer.end(); ++cit) {
886 languages.insert(*cit);
889 MenuItem item(MenuItem::Submenu, qt_("Language|L"));
890 item.setSubmenu(MenuDefinition(qt_("Language")));
891 QString morelangs = qt_("More Languages ...|M");
892 QStringList accelerators;
893 if (morelangs.contains('|'))
894 accelerators.append(morelangs.section('|', -1));
895 std::set<Language const *, sortLanguageByName>::const_iterator const begin = languages.begin();
896 for (std::set<Language const *, sortLanguageByName>::const_iterator cit = begin;
897 cit != languages.end(); ++cit) {
898 QString label = qt_((*cit)->display());
899 // try to add an accelerator
900 bool success = false;
901 // try capitals first
902 for (int i = 0; i < label.size(); ++i) {
903 QChar const ch = label[i];
906 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
907 label = label + toqstr("|") + ch;
908 accelerators.append(ch);
913 // if all capitals are taken, try the rest
915 for (int i = 0; i < label.size(); ++i) {
916 if (label[i].isSpace())
918 QString const ch = QString(label[i]);
919 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
920 label = label + toqstr("|") + ch;
921 accelerators.append(ch);
926 MenuItem w(MenuItem::Command, label,
927 FuncRequest(LFUN_LANGUAGE, (*cit)->lang() + " set"));
928 item.submenu().addWithStatusCheck(w);
930 item.submenu().add(MenuItem(MenuItem::Separator));
931 item.submenu().add(MenuItem(MenuItem::Command, morelangs,
932 FuncRequest(LFUN_DIALOG_SHOW, "character")));
937 void MenuDefinition::expandLastfiles()
939 LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
940 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
944 for (; lfit != lf.end() && ii <= lyxrc.num_lastfiles; ++lfit, ++ii) {
945 string const file = lfit->absFileName();
946 QString const short_path = toqstr(makeDisplayPath(file, 30));
947 QString const long_path = toqstr(makeDisplayPath(file));
950 label = QString("%1. %2|%3").arg(ii).arg(short_path).arg(ii);
952 label = QString("%1. %2").arg(ii).arg(short_path);
953 add(MenuItem(MenuItem::Command, label,
954 FuncRequest(LFUN_FILE_OPEN, file), long_path));
959 void MenuDefinition::expandDocuments()
961 MenuItem item(MenuItem::Submenu, qt_("Hidden|H"));
962 item.setSubmenu(MenuDefinition(qt_("Hidden|H")));
964 Buffer * first = theBufferList().first();
966 add(MenuItem(MenuItem::Info, qt_("<No Documents Open>")));
972 if (!guiApp->currentView())
974 GuiWorkArea * wa = guiApp->currentView()->workArea(i);
977 Buffer const & b = wa->bufferView().buffer();
978 QString label = toqstr(b.fileName().displayName(20));
982 label = QString::number(i) + ". " + label + '|' + QString::number(i);
983 add(MenuItem(MenuItem::Command, label,
984 FuncRequest(LFUN_BUFFER_SWITCH, b.absFileName())));
991 // We cannot use a for loop as the buffer list cycles.
993 if (!(guiApp->currentView()
994 && guiApp->currentView()->workArea(*b))) {
995 QString label = toqstr(b->fileName().displayName(20));
999 label = QString::number(i) + ". " + label + '|' + QString::number(i);
1000 item.submenu().add(MenuItem(MenuItem::Command, label,
1001 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
1004 b = theBufferList().next(b);
1005 } while (b != first);
1007 if (!item.submenu().empty())
1012 void MenuDefinition::expandBookmarks()
1014 lyx::BookmarksSection const & bm = theSession().bookmarks();
1017 for (size_t i = 1; i <= bm.size(); ++i) {
1018 if (bm.isValid(i)) {
1019 string const file = bm.bookmark(i).filename.absFileName();
1020 QString const label = QString("%1. %2|%3").arg(i)
1021 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
1022 add(MenuItem(MenuItem::Command, label,
1023 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
1028 add(MenuItem(MenuItem::Info, qt_("<No Bookmarks Saved Yet>")));
1032 void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf)
1034 if (!buf && kind != MenuItem::ImportFormats)
1037 typedef vector<Format const *> Formats;
1039 FuncCode action = LFUN_NOACTION;
1042 case MenuItem::ImportFormats:
1043 formats = theConverters().importableFormats();
1044 action = LFUN_BUFFER_IMPORT;
1046 case MenuItem::ViewFormats:
1047 formats = buf->params().exportableFormats(true);
1048 action = LFUN_BUFFER_VIEW;
1050 case MenuItem::UpdateFormats:
1051 formats = buf->params().exportableFormats(true);
1052 action = LFUN_BUFFER_UPDATE;
1054 case MenuItem::ExportFormats:
1055 formats = buf->params().exportableFormats(false);
1056 action = LFUN_BUFFER_EXPORT;
1062 sort(formats.begin(), formats.end(), Format::formatSorter);
1064 bool const view_update = (kind == MenuItem::ViewFormats
1065 || kind == MenuItem::UpdateFormats);
1069 smenue = (kind == MenuItem::ViewFormats
1070 ? qt_("View (Other Formats)|F")
1071 : qt_("Update (Other Formats)|p"));
1072 MenuItem item(MenuItem::Submenu, smenue);
1073 item.setSubmenu(MenuDefinition(smenue));
1075 for (Format const * f : formats) {
1079 docstring lab = f->prettyname();
1080 docstring const scut = from_utf8(f->shortcut());
1081 docstring const tmplab = lab;
1084 lab += char_type('|') + scut;
1085 docstring const lab_i18n = translateIfPossible(lab);
1086 docstring const shortcut = split(lab_i18n, lab, '|');
1088 bool const untranslated = (lab == lab_i18n);
1089 docstring label = untranslated ? translateIfPossible(tmplab) : lab;
1092 case MenuItem::ImportFormats:
1093 label += from_ascii("...");
1095 case MenuItem::ViewFormats:
1096 case MenuItem::UpdateFormats:
1097 if (f->name() == buf->params().getDefaultOutputFormat()) {
1098 docstring lbl = (kind == MenuItem::ViewFormats
1099 ? bformat(_("View [%1$s]|V"), label)
1100 : bformat(_("Update [%1$s]|U"), label));
1101 add(MenuItem(MenuItem::Command, toqstr(lbl), FuncRequest(action)));
1105 case MenuItem::ExportFormats:
1106 if (!f->inExportMenu())
1110 // we already asserted earlier in this case
1114 if (!shortcut.empty())
1115 label += '|' + shortcut;
1118 // note that at this point, we know that buf is not null
1120 item.submenu().addWithStatusCheck(MenuItem(MenuItem::Command,
1121 toqstr(label), FuncRequest(action, f->name())));
1124 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1125 FuncRequest(action, f->name())));
1127 add(MenuItem(MenuItem::Command, toqstr(label),
1128 FuncRequest(action, f->name())));
1136 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
1141 FloatList const & floats = buf->params().documentClass().floats();
1142 FloatList::const_iterator cit = floats.begin();
1143 FloatList::const_iterator end = floats.end();
1145 for (; cit != end; ++cit) {
1146 if (!cit->second.usesFloatPkg()) {
1147 // Different floats could declare the same ListCommand. We only
1148 // want it on the list once, though.
1149 string const & list_cmd = cit->second.listCommand();
1150 if (list_cmd.empty())
1151 // we do not know how to generate such a list
1153 // This form of insert returns an iterator pointing to the newly
1154 // inserted element OR the existing element with that value, and
1155 // a bool indicating whether we inserted a new element. So we can
1156 // see if one is there and insert it if not all at once.
1157 pair<set<string>::iterator, bool> ret = seen.insert(list_cmd);
1161 string const & list_name = cit->second.listName();
1162 addWithStatusCheck(MenuItem(MenuItem::Command, qt_(list_name),
1163 FuncRequest(LFUN_FLOAT_LIST_INSERT, cit->second.floattype())));
1168 void MenuDefinition::expandFloatInsert(Buffer const * buf)
1173 FloatList const & floats = buf->params().documentClass().floats();
1174 FloatList::const_iterator cit = floats.begin();
1175 FloatList::const_iterator end = floats.end();
1176 for (; cit != end; ++cit) {
1178 QString const label = qt_(cit->second.name());
1179 addWithStatusCheck(MenuItem(MenuItem::Command, label,
1180 FuncRequest(LFUN_FLOAT_INSERT,
1181 cit->second.floattype())));
1186 void MenuDefinition::expandFlexInsert(
1187 Buffer const * buf, InsetLayout::InsetLyXType type)
1192 TextClass::InsetLayouts const & insetLayouts =
1193 buf->params().documentClass().insetLayouts();
1194 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
1195 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
1196 for (; cit != end; ++cit) {
1197 if (cit->second.lyxtype() == type) {
1198 if (!cit->second.obsoleted_by().empty())
1200 docstring label = cit->first;
1201 // we remove the "Flex:" prefix, if it is present
1202 if (prefixIs(label, from_ascii("Flex:")))
1203 label = label.substr(5);
1204 addWithStatusCheck(MenuItem(MenuItem::Command,
1205 toqstr(translateIfPossible(label)),
1206 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(label))));
1209 // FIXME This is a little clunky.
1210 if (items_.empty() && type == InsetLayout::CUSTOM && !buf->isReadonly())
1211 add(MenuItem(MenuItem::Help, qt_("No Custom Insets Defined!")));
1215 // Threshold before we stop displaying sub-items alongside items
1216 // (for display purposes). Ideally this should fit on a screen.
1217 size_t const max_number_of_items = 30;
1218 // Size limit for the menu. This is for performance purposes,
1219 // because qt already displays a scrollable menu when necessary.
1220 // Ideally this should be the menu size from which scrollable
1221 // menus become unpractical.
1222 size_t const menu_size_limit = 80;
1224 void MenuDefinition::expandToc2(Toc const & toc_list,
1225 size_t from, size_t to, int depth,
1228 int shortcut_count = 0;
1230 // check whether depth is smaller than the smallest depth in toc.
1231 int min_depth = 1000;
1232 for (size_t i = from; i < to; ++i)
1233 min_depth = min(min_depth, toc_list[i].depth());
1234 if (min_depth > depth)
1237 if (to - from <= max_number_of_items) {
1238 for (size_t i = from; i < to; ++i) {
1239 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
1240 label += limitStringLength(toc_list[i].asString());
1241 if (toc_list[i].depth() == depth) {
1243 if (shortcut_count < 9) {
1244 if (label.contains(QString::number(shortcut_count + 1)))
1245 label += QString::number(++shortcut_count);
1248 add(MenuItem(MenuItem::Command, label,
1249 FuncRequest(toc_list[i].action())));
1250 // separator after the menu heading
1251 if (toc_list[i].depth() < depth)
1252 add(MenuItem(MenuItem::Separator));
1258 size_t new_pos = pos + 1;
1259 while (new_pos < to && toc_list[new_pos].depth() > depth)
1262 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
1263 label += limitStringLength(toc_list[pos].asString());
1264 if (toc_list[pos].depth() == depth) {
1266 if (shortcut_count < 9) {
1267 if (label.contains(QString::number(shortcut_count + 1)))
1268 label += QString::number(++shortcut_count);
1271 if (size >= menu_size_limit) {
1272 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + toc_type);
1273 add(MenuItem(MenuItem::Command, "...", f));
1276 if (new_pos == pos + 1) {
1277 add(MenuItem(MenuItem::Command,
1278 label, FuncRequest(toc_list[pos].action())));
1281 sub.expandToc2(toc_list, pos, new_pos, depth + 1, toc_type);
1282 MenuItem item(MenuItem::Submenu, label);
1283 item.setSubmenu(sub);
1293 void MenuDefinition::expandToc(Buffer const * buf)
1295 // To make things very cleanly, we would have to pass buf to
1296 // all MenuItem constructors and to expandToc2. However, we
1297 // know that all the entries in a TOC will be have status_ ==
1298 // OK, so we avoid this unnecessary overhead (JMarc)
1300 add(MenuItem(MenuItem::Info, qt_("(No Document Open)")));
1303 // Add an entry for the master doc if this is a child doc
1304 Buffer const * const master = buf->masterBuffer();
1305 if (buf != master) {
1306 ParIterator const pit = par_iterator_begin(master->inset());
1307 string const arg = convert<string>(pit->id());
1308 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
1309 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
1312 MenuDefinition other_lists;
1313 FloatList const & floatlist = buf->params().documentClass().floats();
1314 TocList const & toc_list = buf->tocBackend().tocs();
1315 TocList::const_iterator cit = toc_list.begin();
1316 TocList::const_iterator end = toc_list.end();
1317 for (; cit != end; ++cit) {
1318 // Handle table of contents later
1319 if (cit->first == "tableofcontents" || cit->second->empty())
1321 MenuDefinition submenu;
1322 // "Open outliner..." entry
1323 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
1324 submenu.add(MenuItem(MenuItem::Command, qt_("Open Outliner..."), f));
1325 submenu.add(MenuItem(MenuItem::Separator));
1327 submenu.expandToc2(*cit->second, 0, cit->second->size(), 0, cit->first);
1328 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
1329 item.setSubmenu(submenu);
1330 // deserves to be in the main menu?
1331 if (floatlist.typeExist(cit->first) || cit->first == "child")
1334 other_lists.add(item);
1336 if (!other_lists.empty()) {
1337 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
1338 item.setSubmenu(other_lists);
1341 // Handle normal TOC
1342 add(MenuItem(MenuItem::Separator));
1343 cit = toc_list.find("tableofcontents");
1345 LYXERR(Debug::GUI, "No table of contents.");
1347 if (!cit->second->empty())
1348 expandToc2(*cit->second, 0, cit->second->size(), 0,
1351 add(MenuItem(MenuItem::Info, qt_("(Empty Table of Contents)")));
1356 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1358 docstring_list const sel = cap::availableSelections(buf);
1360 docstring_list::const_iterator cit = sel.begin();
1361 docstring_list::const_iterator end = sel.end();
1363 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1364 add(MenuItem(MenuItem::Command, toqstr(*cit) + '|',
1365 FuncRequest(LFUN_PASTE, convert<string>(index))));
1370 void MenuDefinition::expandToolbars()
1372 MenuDefinition other_lists;
1373 // extracts the toolbars from the backend
1374 Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1375 Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1376 for (; cit != end; ++cit) {
1377 MenuItem const item(MenuItem::Command, toqstr(cit->gui_name),
1378 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1379 if (guiApp->toolbars().isMainToolbar(cit->name))
1382 other_lists.add(item);
1385 if (!other_lists.empty()) {
1386 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1387 item.setSubmenu(other_lists);
1393 void MenuDefinition::expandBranches(Buffer const * buf)
1395 if (!buf || buf->isReadonly())
1398 BufferParams const & master_params = buf->masterBuffer()->params();
1399 BufferParams const & params = buf->params();
1400 if (params.branchlist().empty() && master_params.branchlist().empty() ) {
1401 add(MenuItem(MenuItem::Help, qt_("No Branches Set for Document!")));
1405 BranchList::const_iterator cit = master_params.branchlist().begin();
1406 BranchList::const_iterator end = master_params.branchlist().end();
1408 for (int ii = 1; cit != end; ++cit, ++ii) {
1409 docstring label = cit->branch();
1411 label = convert<docstring>(ii) + ". " + label
1412 + char_type('|') + convert<docstring>(ii);
1414 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1415 FuncRequest(LFUN_BRANCH_INSERT,
1419 if (buf == buf->masterBuffer())
1422 MenuDefinition child_branches;
1424 BranchList::const_iterator ccit = params.branchlist().begin();
1425 BranchList::const_iterator cend = params.branchlist().end();
1427 for (int ii = 1; ccit != cend; ++ccit, ++ii) {
1428 docstring label = ccit->branch();
1430 label = convert<docstring>(ii) + ". " + label
1431 + char_type('|') + convert<docstring>(ii);
1433 label += char_type('|');
1434 child_branches.addWithStatusCheck(MenuItem(MenuItem::Command,
1436 FuncRequest(LFUN_BRANCH_INSERT,
1440 if (!child_branches.empty()) {
1441 MenuItem item(MenuItem::Submenu, qt_("Child Document"));
1442 item.setSubmenu(child_branches);
1448 void MenuDefinition::expandIndices(Buffer const * buf, bool listof)
1453 BufferParams const & params = buf->masterBuffer()->params();
1454 if (!params.use_indices) {
1456 addWithStatusCheck(MenuItem(MenuItem::Command,
1457 qt_("Index List|I"),
1458 FuncRequest(LFUN_INDEX_PRINT,
1459 from_ascii("idx"))));
1461 addWithStatusCheck(MenuItem(MenuItem::Command,
1462 qt_("Index Entry|d"),
1463 FuncRequest(LFUN_INDEX_INSERT,
1464 from_ascii("idx"))));
1468 if (params.indiceslist().empty())
1471 IndicesList::const_iterator cit = params.indiceslist().begin();
1472 IndicesList::const_iterator end = params.indiceslist().end();
1474 for (int ii = 1; cit != end; ++cit, ++ii) {
1476 docstring const label =
1477 bformat(_("Index: %1$s"), cit->index());
1478 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1479 FuncRequest(LFUN_INDEX_PRINT, cit->shortcut())));
1481 docstring const label =
1482 bformat(_("Index Entry (%1$s)"), cit->index());
1483 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1484 FuncRequest(LFUN_INDEX_INSERT, cit->shortcut())));
1490 void MenuDefinition::expandIndicesContext(Buffer const * buf, bool listof)
1495 BufferParams const & params = buf->masterBuffer()->params();
1496 if (!params.use_indices || params.indiceslist().empty())
1499 IndicesList::const_iterator cit = params.indiceslist().begin();
1500 IndicesList::const_iterator end = params.indiceslist().end();
1502 for (int ii = 1; cit != end; ++cit, ++ii) {
1504 InsetCommandParams p(INDEX_PRINT_CODE);
1505 p["type"] = cit->shortcut();
1506 string const data = InsetCommand::params2string(p);
1507 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
1508 FuncRequest(LFUN_INSET_MODIFY, data)));
1510 docstring const label =
1511 bformat(_("Index Entry (%1$s)"), cit->index());
1512 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1513 FuncRequest(LFUN_INSET_MODIFY,
1514 from_ascii("changetype ") + cit->shortcut())));
1520 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1525 Inset const * inset = bv->cursor().nextInset();
1526 if (!inset || inset->lyxCode() != CITE_CODE) {
1527 add(MenuItem(MenuItem::Command,
1528 qt_("No Citation in Scope!"),
1529 FuncRequest(LFUN_NOACTION)));
1532 InsetCommand const * citinset =
1533 static_cast<InsetCommand const *>(inset);
1535 Buffer const * buf = &bv->buffer();
1536 string const cmd = citinset->params().getCmdName();
1538 docstring const & key = citinset->getParam("key");
1540 add(MenuItem(MenuItem::Command,
1541 qt_("No citations selected!"),
1542 FuncRequest(LFUN_NOACTION)));
1546 docstring const & before = citinset->getParam("before");
1547 docstring const & after = citinset->getParam("after");
1549 size_t const n = cmd.size();
1550 bool const force = cmd[0] == 'C';
1551 bool const full = cmd[n] == '*';
1553 vector<docstring> const keys = getVectorFromString(key);
1555 vector<CitationStyle> const citeStyleList = buf->params().citeStyles();
1556 static const size_t max_length = 40;
1557 vector<docstring> citeStrings =
1558 buf->masterBibInfo().getCiteStrings(keys, citeStyleList, bv->buffer(),
1559 before, after, from_utf8("dialog"), max_length);
1561 vector<docstring>::const_iterator cit = citeStrings.begin();
1562 vector<docstring>::const_iterator end = citeStrings.end();
1564 for (int ii = 1; cit != end; ++cit, ++ii) {
1565 docstring label = *cit;
1566 CitationStyle cs = citeStyleList[ii - 1];
1567 cs.forceUpperCase &= force;
1568 cs.fullAuthorList &= full;
1569 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1570 FuncRequest(LFUN_INSET_MODIFY,
1571 "changetype " + from_utf8(citationStyleToString(cs)))));
1576 void MenuDefinition::expandArguments(BufferView const * bv, bool switcharg)
1581 if (!bv->cursor().inTexted())
1584 Inset const * inset = &bv->cursor().inset();
1585 Layout::LaTeXArgMap args = bv->cursor().paragraph().layout().args();
1586 if (inset && args.empty())
1587 args = inset->getLayout().args();
1588 if (args.empty() || (switcharg && args.size() == 1))
1590 Layout::LaTeXArgMap::const_iterator lait = args.begin();
1591 Layout::LaTeXArgMap::const_iterator const laend = args.end();
1592 for (; lait != laend; ++lait) {
1593 Layout::latexarg arg = (*lait).second;
1594 docstring str = arg.menustring.empty()? arg.labelstring : arg.menustring;
1595 QString item = toqstr(translateIfPossible(str));
1597 add(MenuItem(MenuItem::Command, item,
1598 FuncRequest(LFUN_INSET_MODIFY,
1599 from_ascii("changetype ")
1600 + from_ascii((*lait).first))));
1602 add(MenuItem(MenuItem::Command, item,
1603 FuncRequest(LFUN_ARGUMENT_INSERT,
1604 from_ascii((*lait).first))));
1609 void MenuDefinition::expandCaptions(Buffer const * buf, bool switchcap)
1614 DocumentClass const & dc = buf->params().documentClass();
1615 vector< pair<docstring, FuncRequest> > caps;
1616 for (pair<docstring, InsetLayout> const & il : dc.insetLayouts()) {
1618 docstring const type = split(il.first, instype, ':');
1619 if (instype == "Caption") {
1620 // skip forbidden caption types
1621 FuncRequest const cmd = switchcap
1622 ? FuncRequest(LFUN_INSET_MODIFY, from_ascii("changetype ") + type)
1623 : FuncRequest(LFUN_CAPTION_INSERT, type);
1624 if (getStatus(cmd).enabled())
1625 caps.push_back(make_pair(type, cmd));
1629 if (caps.empty() || (switchcap && caps.size() == 1))
1631 if (caps.size() == 1) {
1632 add(MenuItem(MenuItem::Command, qt_("Caption"), caps.front().second));
1636 MenuDefinition captions;
1637 for (pair<docstring, FuncRequest> const & cap : caps) {
1638 docstring const type = cap.first;
1639 docstring const trtype = translateIfPossible(type);
1640 docstring const cmitem = bformat(_("Caption (%1$s)"), trtype);
1642 add(MenuItem(MenuItem::Command, toqstr(cmitem), cap.second));
1644 captions.add(MenuItem(MenuItem::Command, toqstr(trtype), cap.second));
1646 if (!captions.empty()) {
1647 MenuItem item(MenuItem::Submenu, qt_("Caption"));
1648 item.setSubmenu(captions);
1654 void MenuDefinition::expandEnvironmentSeparators(BufferView const * bv)
1658 Text const * text = bv->cursor().text();
1659 // no paragraphs and no separators exist in math
1663 pit_type pit = bv->cursor().selBegin().pit();
1664 Paragraph const & par = text->getPar(pit);
1665 docstring const curlayout = par.layout().name();
1666 docstring outerlayout;
1667 depth_type current_depth = par.params().depth();
1668 // check if we have an environment in our nesting hierarchy
1669 Paragraph cpar = par;
1671 if (pit == 0 || cpar.params().depth() == 0)
1674 cpar = text->getPar(pit);
1675 if (cpar.params().depth() < current_depth
1676 && cpar.layout().isEnvironment()) {
1677 outerlayout = cpar.layout().name();
1678 current_depth = cpar.params().depth();
1681 if (par.layout().isEnvironment()) {
1682 docstring const label =
1683 bformat(_("Start New Environment (%1$s)"),
1684 translateIfPossible(curlayout));
1685 add(MenuItem(MenuItem::Command, toqstr(label),
1686 FuncRequest(LFUN_ENVIRONMENT_SPLIT)));
1688 if (!outerlayout.empty()) {
1689 docstring const label =
1690 bformat(_("Start New Parent Environment (%1$s)"),
1691 translateIfPossible(outerlayout));
1692 add(MenuItem(MenuItem::Command, toqstr(label),
1693 FuncRequest(LFUN_ENVIRONMENT_SPLIT,
1694 from_ascii("outer"))));
1701 /////////////////////////////////////////////////////////////////////
1702 // Menu::Impl definition and implementation
1703 /////////////////////////////////////////////////////////////////////
1707 /// populates the menu or one of its submenu
1708 /// This is used as a recursive function
1709 void populate(QMenu * qMenu, MenuDefinition const & menu);
1711 /// Only needed for top level menus.
1712 MenuDefinition * top_level_menu;
1715 /// the name of this menu
1721 /// Get a MenuDefinition item label from the menu backend
1722 static QString label(MenuItem const & mi)
1724 QString label = mi.label();
1725 label.replace("&", "&&");
1727 QString shortcut = mi.shortcut();
1728 if (!shortcut.isEmpty()) {
1729 int pos = label.indexOf(shortcut);
1731 //label.insert(pos, 1, char_type('&'));
1732 label.replace(pos, 0, "&");
1735 QString const binding = mi.binding();
1736 if (!binding.isEmpty())
1737 label += '\t' + binding;
1742 void Menu::Impl::populate(QMenu * qMenu, MenuDefinition const & menu)
1744 LYXERR(Debug::GUI, "populating menu " << menu.name());
1746 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
1749 LYXERR(Debug::GUI, " ***** menu entries " << menu.size());
1750 for (MenuItem const & m : menu)
1752 case MenuItem::Separator:
1753 qMenu->addSeparator();
1755 case MenuItem::Submenu: {
1756 QMenu * subMenu = qMenu->addMenu(label(m));
1757 populate(subMenu, m.submenu());
1758 subMenu->setEnabled(!subMenu->isEmpty());
1761 case MenuItem::Command:
1763 // FIXME: A previous comment assured that MenuItem::Command was the
1764 // only possible case in practice, but this is wrong. It would be
1765 // good to document which cases are actually treated here.
1766 qMenu->addAction(new Action(m.func(), QIcon(), label(m),
1767 m.tooltip(), qMenu));
1772 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
1773 class AlwaysMnemonicStyle : public QProxyStyle {
1775 int styleHint(StyleHint hint, const QStyleOption *opt = 0, const QWidget *widget = 0,
1776 QStyleHintReturn *returnData = 0) const
1778 if (hint == QStyle::SH_UnderlineShortcut)
1780 return QProxyStyle::styleHint(hint, opt, widget, returnData);
1785 /////////////////////////////////////////////////////////////////////
1786 // Menu implementation
1787 /////////////////////////////////////////////////////////////////////
1789 Menu::Menu(GuiView * gv, QString const & name, bool top_level, bool keyboard)
1790 : QMenu(gv), d(new Menu::Impl)
1792 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
1794 setStyle(new AlwaysMnemonicStyle);
1798 d->top_level_menu = top_level? new MenuDefinition : 0;
1802 if (d->top_level_menu)
1803 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1809 delete d->top_level_menu;
1814 void Menu::updateView()
1816 guiApp->menus().updateMenu(this);
1822 QList<QAction *> items = actions();
1823 for (int i = 0; i != items.size(); ++i) {
1824 // QAction::menu() returns 0 if there's no submenu.
1825 delete items.at(i)->menu();
1831 /////////////////////////////////////////////////////////////////////
1832 // Menus::Impl definition and implementation
1833 /////////////////////////////////////////////////////////////////////
1835 struct Menus::Impl {
1837 bool hasMenu(QString const &) const;
1839 MenuDefinition & getMenu(QString const &);
1841 MenuDefinition const & getMenu(QString const &) const;
1843 /// Expands some special entries of the menu
1844 /** The entries with the following kind are expanded to a
1845 sequence of Command MenuItems: Lastfiles, Documents,
1846 ViewFormats, ExportFormats, UpdateFormats, Branches,
1847 Indices, Arguments, SwitchArguments, Captions, SwitchCaptions,
1848 EnvironmentSeparators
1850 void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1851 BufferView const *) const;
1853 /// Initialize specific MACOS X menubar
1854 void macxMenuBarInit(QMenuBar * qmb);
1856 /// Mac special menu.
1857 /** This defines a menu whose entries list the FuncRequests
1858 that will be removed by expand() in other menus. This is
1859 used by the Qt/Mac code.
1861 NOTE: Qt does not remove the menu items when clearing a QMenuBar,
1862 such that the items will keep accessing the FuncRequests in
1863 the MenuDefinition. While Menus::Impl might be recreated,
1864 we keep mac_special_menu_ in memory by making it static.
1866 static MenuDefinition mac_special_menu_;
1871 MenuDefinition menubar_;
1873 typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
1875 /// name to menu for \c menu() method.
1880 MenuDefinition Menus::Impl::mac_special_menu_;
1884 Here is what the Qt documentation says about how a menubar is chosen:
1886 1) If the window has a QMenuBar then it is used. 2) If the window
1887 is a modal then its menubar is used. If no menubar is specified
1888 then a default menubar is used (as documented below) 3) If the
1889 window has no parent then the default menubar is used (as
1892 The above 3 steps are applied all the way up the parent window
1893 chain until one of the above are satisifed. If all else fails a
1894 default menubar will be created, the default menubar on Qt/Mac is
1895 an empty menubar, however you can create a different default
1896 menubar by creating a parentless QMenuBar, the first one created
1897 will thus be designated the default menubar, and will be used
1898 whenever a default menubar is needed.
1900 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1901 that this menubar will be used also when one of LyX' dialogs has
1904 void Menus::Impl::macxMenuBarInit(QMenuBar * qmb)
1906 /* Since Qt 4.2, the qt/mac menu code has special code for
1907 specifying the role of a menu entry. However, it does not
1908 work very well with our scheme of creating menus on demand,
1909 and therefore we need to put these entries in a special
1910 invisible menu. (JMarc)
1913 /* The entries of our special mac menu. If we add support for
1914 * special entries in Menus, we could imagine something
1916 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
1917 * and therefore avoid hardcoding. I am not sure it is worth
1918 * the hassle, though. (JMarc)
1920 struct MacMenuEntry {
1924 QAction::MenuRole role;
1927 static const MacMenuEntry entries[] = {
1928 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1929 QAction::AboutRole},
1930 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1931 QAction::PreferencesRole},
1932 #if !(defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
1933 /* This doesn't work with Cocoa. */
1934 {LFUN_RECONFIGURE, "", "Reconfigure",
1935 QAction::ApplicationSpecificRole},
1937 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1939 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1940 const bool first_call = mac_special_menu_.empty();
1942 LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
1943 // the special menu for Menus. Fill it up only once.
1945 for (size_t i = 0 ; i < num_entries ; ++i) {
1946 FuncRequest const func(entries[i].action,
1947 from_utf8(entries[i].arg));
1948 mac_special_menu_.add(MenuItem(MenuItem::Command,
1949 entries[i].label, func));
1953 // add the entries to a QMenu that will eventually be empty
1954 // and therefore invisible.
1955 QMenu * qMenu = qmb->addMenu("special");
1957 for (MenuItem const & m : mac_special_menu_) {
1958 Action * action = new Action(m.func(), QIcon(), m.label(),
1960 action->setMenuRole(entries[i].role);
1961 qMenu->addAction(action);
1966 void Menus::Impl::expand(MenuDefinition const & frommenu,
1967 MenuDefinition & tomenu, BufferView const * bv) const
1969 if (!tomenu.empty())
1972 for (MenuDefinition::const_iterator cit = frommenu.begin();
1973 cit != frommenu.end() ; ++cit) {
1974 Buffer const * buf = bv ? &bv->buffer() : 0;
1975 switch (cit->kind()) {
1976 case MenuItem::Lastfiles:
1977 tomenu.expandLastfiles();
1980 case MenuItem::Documents:
1981 tomenu.expandDocuments();
1984 case MenuItem::Bookmarks:
1985 tomenu.expandBookmarks();
1988 case MenuItem::ImportFormats:
1989 case MenuItem::ViewFormats:
1990 case MenuItem::UpdateFormats:
1991 case MenuItem::ExportFormats:
1992 tomenu.expandFormats(cit->kind(), buf);
1995 case MenuItem::CharStyles:
1996 tomenu.expandFlexInsert(buf, InsetLayout::CHARSTYLE);
1999 case MenuItem::Custom:
2000 tomenu.expandFlexInsert(buf, InsetLayout::CUSTOM);
2003 case MenuItem::Elements:
2004 tomenu.expandFlexInsert(buf, InsetLayout::ELEMENT);
2007 case MenuItem::FloatListInsert:
2008 tomenu.expandFloatListInsert(buf);
2011 case MenuItem::FloatInsert:
2012 tomenu.expandFloatInsert(buf);
2015 case MenuItem::PasteRecent:
2016 tomenu.expandPasteRecent(buf);
2019 case MenuItem::Toolbars:
2020 tomenu.expandToolbars();
2023 case MenuItem::Branches:
2024 tomenu.expandBranches(buf);
2027 case MenuItem::Indices:
2028 tomenu.expandIndices(buf);
2031 case MenuItem::IndicesContext:
2032 tomenu.expandIndicesContext(buf);
2035 case MenuItem::IndicesLists:
2036 tomenu.expandIndices(buf, true);
2039 case MenuItem::IndicesListsContext:
2040 tomenu.expandIndicesContext(buf, true);
2043 case MenuItem::CiteStyles:
2044 tomenu.expandCiteStyles(bv);
2048 tomenu.expandToc(buf);
2051 case MenuItem::GraphicsGroups:
2052 tomenu.expandGraphicsGroups(bv);
2055 case MenuItem::SpellingSuggestions:
2056 tomenu.expandSpellingSuggestions(bv);
2059 case MenuItem::LanguageSelector:
2060 tomenu.expandLanguageSelector(buf);
2063 case MenuItem::Arguments:
2064 tomenu.expandArguments(bv, false);
2067 case MenuItem::SwitchArguments:
2068 tomenu.expandArguments(bv, true);
2071 case MenuItem::Captions:
2072 tomenu.expandCaptions(buf, false);
2075 case MenuItem::SwitchCaptions:
2076 tomenu.expandCaptions(buf, true);
2079 case MenuItem::EnvironmentSeparators:
2080 tomenu.expandEnvironmentSeparators(bv);
2083 case MenuItem::Submenu: {
2084 MenuItem item(*cit);
2085 item.setSubmenu(MenuDefinition(cit->submenuname()));
2086 expand(getMenu(cit->submenuname()), item.submenu(), bv);
2087 tomenu.addWithStatusCheck(item);
2091 case MenuItem::Info:
2092 case MenuItem::Help:
2093 case MenuItem::Separator:
2094 tomenu.addWithStatusCheck(*cit);
2097 case MenuItem::Command:
2098 if (!mac_special_menu_.hasFunc(*cit->func()))
2099 tomenu.addWithStatusCheck(*cit);
2103 // we do not want the menu to end with a separator
2104 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
2105 tomenu.items_.pop_back();
2107 // Check whether the shortcuts are unique
2108 tomenu.checkShortcuts();
2112 bool Menus::Impl::hasMenu(QString const & name) const
2114 return find_if(menulist_.begin(), menulist_.end(),
2115 MenuNamesEqual(name)) != menulist_.end();
2119 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
2121 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
2122 MenuNamesEqual(name));
2123 if (cit == menulist_.end()) {
2124 LYXERR0("No submenu named " << name);
2125 LASSERT(false, { static const MenuDefinition m; return m; });
2131 MenuDefinition & Menus::Impl::getMenu(QString const & name)
2133 iterator it = find_if(menulist_.begin(), menulist_.end(),
2134 MenuNamesEqual(name));
2135 if (it == menulist_.end()) {
2136 LYXERR0("No submenu named " << name);
2137 LASSERT(false, { static MenuDefinition m; return m; });
2143 /////////////////////////////////////////////////////////////////////
2147 /////////////////////////////////////////////////////////////////////
2149 Menus::Menus() : d(new Impl) {}
2165 void Menus::read(Lexer & lex)
2173 LexerKeyword menutags[] = {
2174 { "end", md_endmenuset },
2175 { "menu", md_menu },
2176 { "menubar", md_menubar }
2179 // consistency check
2180 if (compare_ascii_no_case(lex.getString(), "menuset"))
2181 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
2183 lex.pushTable(menutags);
2184 lex.setContext("Menus::read");
2188 while (lex.isOK() && !quit) {
2189 switch (lex.lex()) {
2191 d->menubar_.read(lex);
2195 QString const name = toqstr(lex.getDocString());
2196 if (d->hasMenu(name))
2197 d->getMenu(name).read(lex);
2199 MenuDefinition menu(name);
2201 d->menulist_.push_back(menu);
2209 lex.printError("Unknown menu tag");
2217 bool Menus::searchMenu(FuncRequest const & func,
2218 docstring_list & names) const
2220 MenuDefinition menu;
2221 d->expand(d->menubar_, menu, 0);
2222 return menu.searchMenu(func, names);
2226 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
2230 // setup special mac specific menu items, but only do this
2231 // the first time a QMenuBar is created. Otherwise Qt will
2232 // create duplicate items in the application menu. It seems
2233 // that Qt does not remove them when the QMenubar is cleared.
2234 d->macxMenuBarInit(qmb);
2237 // Clear all menubar contents before filling it.
2239 #if (QT_VERSION >= 0x050000 && defined(Q_OS_MAC))
2240 d->macxMenuBarInit(qmb);
2244 LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
2246 if (d->menubar_.empty()) {
2247 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
2248 << d->menubar_.name());
2251 LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
2253 MenuDefinition menu;
2254 BufferView * bv = 0;
2256 bv = view->currentBufferView();
2257 d->expand(d->menubar_, menu, bv);
2259 MenuDefinition::const_iterator m = menu.begin();
2260 MenuDefinition::const_iterator end = menu.end();
2262 for (; m != end; ++m) {
2264 if (m->kind() != MenuItem::Submenu) {
2265 LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
2269 LYXERR(Debug::GUI, "menu bar item " << m->label()
2270 << " is a submenu named " << m->submenuname());
2272 QString name = m->submenuname();
2273 if (!d->hasMenu(name)) {
2274 LYXERR(Debug::GUI, "\tERROR: " << name
2275 << " submenu has no menu!");
2279 Menu * menu = new Menu(view, m->submenuname(), true);
2280 menu->setTitle(label(*m));
2282 #if defined(Q_OS_MAC) && (defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
2283 // On Mac OS with QT/cocoa, the menu is not displayed if there is no action
2284 // so we create a temporary one here
2285 QAction * action = new QAction(menu);
2286 menu->addAction(action);
2291 d->name_map_[view][name] = menu;
2296 void Menus::updateMenu(Menu * qmenu)
2298 LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
2301 if (qmenu->d->name.isEmpty())
2304 docstring identifier = qstring_to_ucs4(qmenu->d->name);
2305 MenuDefinition fromLyxMenu(qmenu->d->name);
2306 while (!identifier.empty()) {
2307 docstring menu_name;
2308 identifier = split(identifier, menu_name, ';');
2310 if (!d->hasMenu(toqstr(menu_name))) {
2311 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
2316 MenuDefinition cat_menu = d->getMenu(toqstr(menu_name));
2317 //FIXME: 50 is a wild guess. We should take into account here
2318 //the expansion of menu items, disabled optional items etc.
2319 bool const in_sub_menu = !fromLyxMenu.empty()
2320 && fromLyxMenu.size() + cat_menu.size() > 50 ;
2322 fromLyxMenu.catSub(menu_name);
2324 fromLyxMenu.cat(cat_menu);
2325 fromLyxMenu.add(MenuItem(MenuItem::Separator));
2328 if (fromLyxMenu.empty()) {
2329 qmenu->addAction(qt_("No Action Defined!"));
2333 BufferView * bv = 0;
2335 bv = qmenu->d->view->currentBufferView();
2336 d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
2337 qmenu->d->populate(qmenu, *qmenu->d->top_level_menu);
2341 Menu * Menus::menu(QString const & name, GuiView & view, bool keyboard)
2343 LYXERR(Debug::GUI, "Context menu requested: " << name);
2344 Menu * menu = d->name_map_[&view].value(name, 0);
2345 if (!menu && !name.startsWith("context-")) {
2346 LYXERR0("requested context menu not found: " << name);
2350 menu = new Menu(&view, name, true, keyboard);
2351 d->name_map_[&view][name] = menu;
2355 } // namespace frontend
2358 #include "moc_Menus.cpp"