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 const_iterator begin() const { return items_.begin(); }
324 const_iterator end() const { return items_.end(); }
326 void cat(MenuDefinition const & other);
328 void catSub(docstring const & name);
330 // search for func in this menu iteratively, and put menu
332 bool searchMenu(FuncRequest const & func, docstring_list & names)
335 bool hasFunc(FuncRequest const &) const;
336 /// Add the menu item unconditionally
337 void add(MenuItem const & item) { items_.push_back(item); }
338 /// Checks the associated FuncRequest status before adding the
340 void addWithStatusCheck(MenuItem const &);
341 // Check whether the menu shortcuts are unique
342 void checkShortcuts() const;
344 void expandLastfiles();
345 void expandDocuments();
346 void expandBookmarks();
347 void expandFormats(MenuItem::Kind const kind, Buffer const * buf);
348 void expandFloatListInsert(Buffer const * buf);
349 void expandFloatInsert(Buffer const * buf);
350 void expandFlexInsert(Buffer const * buf, InsetLayout::InsetLyXType type);
351 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth, string toc_type);
352 void expandToc(Buffer const * buf);
353 void expandPasteRecent(Buffer const * buf);
354 void expandToolbars();
355 void expandBranches(Buffer const * buf);
356 void expandIndices(Buffer const * buf, bool listof = false);
357 void expandIndicesContext(Buffer const * buf, bool listof = false);
358 void expandCiteStyles(BufferView const *);
359 void expandGraphicsGroups(BufferView const *);
360 void expandSpellingSuggestions(BufferView const *);
361 void expandLanguageSelector(Buffer const * buf);
362 void expandArguments(BufferView const *, bool switcharg = false);
363 void expandCaptions(Buffer const * buf, bool switchcap = false);
364 void expandEnvironmentSeparators(BufferView const *);
372 /// Helper for std::find_if
376 MenuNamesEqual(QString const & name) : name_(name) {}
377 bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
384 typedef std::vector<MenuDefinition> MenuList;
386 typedef MenuList::const_iterator const_iterator;
388 typedef MenuList::iterator iterator;
390 /////////////////////////////////////////////////////////////////////
391 // MenuDefinition implementation
392 /////////////////////////////////////////////////////////////////////
394 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
398 case MenuItem::Command: {
399 FuncStatus status = lyx::getStatus(*i.func());
400 if (status.unknown() || (!status.enabled() && i.optional()))
403 items_.back().status(status);
407 case MenuItem::Submenu: {
408 bool enabled = false;
409 if (i.hasSubmenu()) {
410 for (const_iterator cit = i.submenu().begin();
411 cit != i.submenu().end(); ++cit) {
412 // Only these kind of items affect the status of the submenu
413 if ((cit->kind() == MenuItem::Command
414 || cit->kind() == MenuItem::Submenu
415 || cit->kind() == MenuItem::Help)
416 && cit->status().enabled()) {
422 if (enabled || !i.optional()) {
424 items_.back().status().setEnabled(enabled);
429 case MenuItem::Separator:
430 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
440 void MenuDefinition::read(Lexer & lex)
457 md_indiceslistscontext,
471 md_spellingsuggestions,
480 LexerKeyword menutags[] = {
481 { "arguments", md_arguments },
482 { "bookmarks", md_bookmarks },
483 { "branches", md_branches },
484 { "captions", md_captions },
485 { "charstyles", md_charstyles },
486 { "citestyles", md_citestyles },
487 { "custom", md_custom },
488 { "documents", md_documents },
489 { "elements", md_elements },
490 { "end", md_endmenu },
491 { "environmentseparators", md_env_separators },
492 { "exportformats", md_exportformats },
493 { "floatinsert", md_floatinsert },
494 { "floatlistinsert", md_floatlistinsert },
495 { "graphicsgroups", md_graphicsgroups },
496 { "importformats", md_importformats },
497 { "indices", md_indices },
498 { "indicescontext", md_indicescontext },
499 { "indiceslists", md_indiceslists },
500 { "indiceslistscontext", md_indiceslistscontext },
502 { "languageselector", md_languageselector },
503 { "lastfiles", md_lastfiles },
504 { "optitem", md_optitem },
505 { "optsubmenu", md_optsubmenu },
506 { "pasterecent", md_pasterecent },
507 { "separator", md_separator },
508 { "spellingsuggestions", md_spellingsuggestions },
509 { "submenu", md_submenu },
510 { "switcharguments", md_switcharguments },
511 { "switchcaptions", md_switchcaptions },
513 { "toolbars", md_toolbars },
514 { "updateformats", md_updateformats },
515 { "viewformats", md_viewformats }
518 lex.pushTable(menutags);
519 lex.setContext("MenuDefinition::read: ");
522 while (lex.isOK() && md_type != md_endmenu) {
523 switch (md_type = lex.lex()) {
527 docstring const name = translateIfPossible(lex.getDocString());
529 string const command = lex.getString();
530 FuncRequest func = lyxaction.lookupFunc(command);
531 FuncRequest::Origin origin = FuncRequest::MENU;
532 if (name_.startsWith("context-toc-"))
533 origin = FuncRequest::TOC;
534 bool const optional = (md_type == md_optitem);
535 add(MenuItem(MenuItem::Command, toqstr(name), func, QString(), optional, origin));
540 add(MenuItem(MenuItem::Separator));
544 add(MenuItem(MenuItem::Lastfiles));
548 add(MenuItem(MenuItem::CharStyles));
552 add(MenuItem(MenuItem::Custom));
556 add(MenuItem(MenuItem::Elements));
560 add(MenuItem(MenuItem::Documents));
564 add(MenuItem(MenuItem::Bookmarks));
568 add(MenuItem(MenuItem::Toc));
572 add(MenuItem(MenuItem::ViewFormats));
575 case md_updateformats:
576 add(MenuItem(MenuItem::UpdateFormats));
579 case md_exportformats:
580 add(MenuItem(MenuItem::ExportFormats));
583 case md_importformats:
584 add(MenuItem(MenuItem::ImportFormats));
587 case md_floatlistinsert:
588 add(MenuItem(MenuItem::FloatListInsert));
592 add(MenuItem(MenuItem::FloatInsert));
596 add(MenuItem(MenuItem::PasteRecent));
600 add(MenuItem(MenuItem::Toolbars));
604 add(MenuItem(MenuItem::Branches));
608 add(MenuItem(MenuItem::CiteStyles));
611 case md_graphicsgroups:
612 add(MenuItem(MenuItem::GraphicsGroups));
615 case md_spellingsuggestions:
616 add(MenuItem(MenuItem::SpellingSuggestions));
619 case md_languageselector:
620 add(MenuItem(MenuItem::LanguageSelector));
624 add(MenuItem(MenuItem::Indices));
627 case md_indicescontext:
628 add(MenuItem(MenuItem::IndicesContext));
631 case md_indiceslists:
632 add(MenuItem(MenuItem::IndicesLists));
635 case md_indiceslistscontext:
636 add(MenuItem(MenuItem::IndicesListsContext));
640 add(MenuItem(MenuItem::Arguments));
643 case md_switcharguments:
644 add(MenuItem(MenuItem::SwitchArguments));
648 add(MenuItem(MenuItem::Captions));
651 case md_switchcaptions:
652 add(MenuItem(MenuItem::SwitchCaptions));
655 case md_env_separators:
656 add(MenuItem(MenuItem::EnvironmentSeparators));
662 docstring const mlabel = translateIfPossible(lex.getDocString());
664 docstring const mname = lex.getDocString();
665 bool const optional = (md_type == md_optsubmenu);
666 add(MenuItem(MenuItem::Submenu,
667 toqstr(mlabel), toqstr(mname), QString(), optional));
675 lex.printError("Unknown menu tag");
683 bool MenuDefinition::hasFunc(FuncRequest const & func) const
685 for (const_iterator it = begin(), et = end(); it != et; ++it)
686 if (*it->func() == func)
692 void MenuDefinition::catSub(docstring const & name)
694 add(MenuItem(MenuItem::Submenu,
695 qt_("More...|M"), toqstr(name), QString(), false));
698 void MenuDefinition::cat(MenuDefinition const & other)
700 const_iterator et = other.end();
701 for (const_iterator it = other.begin(); it != et; ++it)
706 void MenuDefinition::checkShortcuts() const
708 // This is a quadratic algorithm, but we do not care because
709 // menus are short enough
710 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
711 QString shortcut = it1->shortcut();
712 if (shortcut.isEmpty())
714 if (!it1->label().contains(shortcut))
715 LYXERR0("Menu warning: menu entry \""
717 << "\" does not contain shortcut `"
718 << shortcut << "'.");
719 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
720 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
721 LYXERR0("Menu warning: menu entries "
722 << '"' << it1->fulllabel()
723 << "\" and \"" << it2->fulllabel()
724 << "\" share the same shortcut.");
731 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
733 const_iterator m = begin();
734 const_iterator m_end = end();
735 for (; m != m_end; ++m) {
736 if (m->kind() == MenuItem::Command && *m->func() == func) {
737 names.push_back(qstring_to_ucs4(m->label()));
740 if (m->kind() == MenuItem::Submenu) {
741 names.push_back(qstring_to_ucs4(m->label()));
742 if (!m->hasSubmenu()) {
743 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
744 << m->label() << " name=" << m->submenuname());
748 if (m->submenu().searchMenu(func, names))
757 QString limitStringLength(docstring const & str)
759 size_t const max_item_length = 45;
760 docstring ret = str.substr(0, max_item_length + 1);
761 support::truncateWithEllipsis(ret, max_item_length);
766 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
771 graphics::getGraphicsGroups(bv->buffer(), grp);
775 set<string>::const_iterator it = grp.begin();
776 set<string>::const_iterator end = grp.end();
777 add(MenuItem(MenuItem::Command, qt_("No Group"),
778 FuncRequest(LFUN_SET_GRAPHICS_GROUP)));
779 for (; it != end; ++it) {
780 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it) + '|',
781 FuncRequest(LFUN_SET_GRAPHICS_GROUP, *it)));
786 void MenuDefinition::expandSpellingSuggestions(BufferView const * bv)
790 Cursor const & cur = bv->cursor();
794 docstring_list suggestions;
795 Paragraph const & par = cur.paragraph();
796 pos_type from = cur.pos();
798 SpellChecker::Result res = par.spellCheck(from, to, wl, suggestions, true, true);
800 case SpellChecker::UNKNOWN_WORD:
801 if (lyxrc.spellcheck_continuously) {
802 LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
803 docstring const & selection = cur.selectionAsString(false);
804 if (!cur.selection() || selection == wl.word()) {
806 size_t m = 10; // first submenu index
807 MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
808 item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
809 for (; i != suggestions.size(); ++i) {
810 docstring const & suggestion = suggestions[i];
811 LYXERR(Debug::GUI, suggestion);
812 MenuItem w(MenuItem::Command, toqstr(suggestion),
813 FuncRequest(LFUN_WORD_REPLACE,
814 replace2string(suggestion, selection,
815 true, // case sensitive
819 false))); // find next
823 item.submenu().add(w);
828 add(MenuItem(MenuItem::Separator));
829 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
830 add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|n"),
831 FuncRequest(LFUN_SPELLING_ADD, arg)));
832 add(MenuItem(MenuItem::Command, qt_("Ignore all|I"),
833 FuncRequest(LFUN_SPELLING_IGNORE, arg)));
837 case SpellChecker::LEARNED_WORD: {
838 LYXERR(Debug::GUI, "Learned Word.");
839 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
840 add(MenuItem(MenuItem::Command, qt_("Remove from personal dictionary|r"),
841 FuncRequest(LFUN_SPELLING_REMOVE, arg)));
844 case SpellChecker::NO_DICTIONARY:
845 LYXERR(Debug::GUI, "No dictionary for language " + from_ascii(wl.lang()->lang()));
847 case SpellChecker::WORD_OK:
848 case SpellChecker::COMPOUND_WORD:
849 case SpellChecker::ROOT_FOUND:
850 case SpellChecker::IGNORED_WORD:
855 struct sortLanguageByName {
856 bool operator()(const Language * a, const Language * b) const {
857 return qt_(a->display()).localeAwareCompare(qt_(b->display())) < 0;
861 void MenuDefinition::expandLanguageSelector(Buffer const * buf)
866 std::set<Language const *> languages_buffer =
867 buf->masterBuffer()->getLanguages();
869 if (languages_buffer.size() < 2)
872 std::set<Language const *, sortLanguageByName> languages;
874 std::set<Language const *>::const_iterator const beg =
875 languages_buffer.begin();
876 for (std::set<Language const *>::const_iterator cit = beg;
877 cit != languages_buffer.end(); ++cit) {
878 languages.insert(*cit);
881 MenuItem item(MenuItem::Submenu, qt_("Language|L"));
882 item.setSubmenu(MenuDefinition(qt_("Language")));
883 QString morelangs = qt_("More Languages ...|M");
884 QStringList accelerators;
885 if (morelangs.contains('|'))
886 accelerators.append(morelangs.section('|', -1));
887 std::set<Language const *, sortLanguageByName>::const_iterator const begin = languages.begin();
888 for (std::set<Language const *, sortLanguageByName>::const_iterator cit = begin;
889 cit != languages.end(); ++cit) {
890 QString label = qt_((*cit)->display());
891 // try to add an accelerator
892 bool success = false;
893 // try capitals first
894 for (int i = 0; i < label.size(); ++i) {
895 QChar const ch = label[i];
898 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
899 label = label + toqstr("|") + ch;
900 accelerators.append(ch);
905 // if all capitals are taken, try the rest
907 for (int i = 0; i < label.size(); ++i) {
908 if (label[i].isSpace())
910 QString const ch = QString(label[i]);
911 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
912 label = label + toqstr("|") + ch;
913 accelerators.append(ch);
918 MenuItem w(MenuItem::Command, label,
919 FuncRequest(LFUN_LANGUAGE, (*cit)->lang() + " set"));
920 item.submenu().addWithStatusCheck(w);
922 item.submenu().add(MenuItem(MenuItem::Separator));
923 item.submenu().add(MenuItem(MenuItem::Command, morelangs,
924 FuncRequest(LFUN_DIALOG_SHOW, "character")));
929 void MenuDefinition::expandLastfiles()
931 LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
932 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
936 for (; lfit != lf.end() && ii <= lyxrc.num_lastfiles; ++lfit, ++ii) {
937 string const file = lfit->absFileName();
938 QString const short_path = toqstr(makeDisplayPath(file, 30));
939 QString const long_path = toqstr(makeDisplayPath(file));
942 label = QString("%1. %2|%3").arg(ii).arg(short_path).arg(ii);
944 label = QString("%1. %2").arg(ii).arg(short_path);
945 add(MenuItem(MenuItem::Command, label,
946 FuncRequest(LFUN_FILE_OPEN, file), long_path));
951 void MenuDefinition::expandDocuments()
953 MenuItem item(MenuItem::Submenu, qt_("Hidden|H"));
954 item.setSubmenu(MenuDefinition(qt_("Hidden|H")));
956 Buffer * first = theBufferList().first();
958 add(MenuItem(MenuItem::Info, qt_("<No Documents Open>")));
964 if (!guiApp->currentView())
966 GuiWorkArea * wa = guiApp->currentView()->workArea(i);
969 Buffer const & b = wa->bufferView().buffer();
970 QString label = toqstr(b.fileName().displayName(20));
974 label = QString::number(i) + ". " + label + '|' + QString::number(i);
975 add(MenuItem(MenuItem::Command, label,
976 FuncRequest(LFUN_BUFFER_SWITCH, b.absFileName())));
983 // We cannot use a for loop as the buffer list cycles.
985 if (!(guiApp->currentView()
986 && guiApp->currentView()->workArea(*b))) {
987 QString label = toqstr(b->fileName().displayName(20));
991 label = QString::number(i) + ". " + label + '|' + QString::number(i);
992 item.submenu().add(MenuItem(MenuItem::Command, label,
993 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
996 b = theBufferList().next(b);
997 } while (b != first);
999 if (!item.submenu().empty())
1004 void MenuDefinition::expandBookmarks()
1006 lyx::BookmarksSection const & bm = theSession().bookmarks();
1009 for (size_t i = 1; i <= bm.size(); ++i) {
1010 if (bm.isValid(i)) {
1011 string const file = bm.bookmark(i).filename.absFileName();
1012 QString const label = QString("%1. %2|%3").arg(i)
1013 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
1014 add(MenuItem(MenuItem::Command, label,
1015 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
1020 add(MenuItem(MenuItem::Info, qt_("<No Bookmarks Saved Yet>")));
1024 void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf)
1026 if (!buf && kind != MenuItem::ImportFormats)
1029 typedef vector<Format const *> Formats;
1031 FuncCode action = LFUN_NOACTION;
1034 case MenuItem::ImportFormats:
1035 formats = theConverters().importableFormats();
1036 action = LFUN_BUFFER_IMPORT;
1038 case MenuItem::ViewFormats:
1039 formats = buf->params().exportableFormats(true);
1040 action = LFUN_BUFFER_VIEW;
1042 case MenuItem::UpdateFormats:
1043 formats = buf->params().exportableFormats(true);
1044 action = LFUN_BUFFER_UPDATE;
1046 case MenuItem::ExportFormats:
1047 formats = buf->params().exportableFormats(false);
1048 action = LFUN_BUFFER_EXPORT;
1055 bool const view_update = (kind == MenuItem::ViewFormats
1056 || kind == MenuItem::UpdateFormats);
1060 smenue = (kind == MenuItem::ViewFormats
1061 ? qt_("View (Other Formats)|F")
1062 : qt_("Update (Other Formats)|p"));
1063 MenuItem item(MenuItem::Submenu, smenue);
1064 item.setSubmenu(MenuDefinition(smenue));
1066 for (Format const * f : formats) {
1070 docstring lab = f->prettyname();
1071 docstring const scut = from_utf8(f->shortcut());
1072 docstring const tmplab = lab;
1075 lab += char_type('|') + scut;
1076 docstring const lab_i18n = translateIfPossible(lab);
1077 docstring const shortcut = split(lab_i18n, lab, '|');
1079 bool const untranslated = (lab == lab_i18n);
1080 docstring label = untranslated ? translateIfPossible(tmplab) : lab;
1083 case MenuItem::ImportFormats:
1084 label += from_ascii("...");
1086 case MenuItem::ViewFormats:
1087 case MenuItem::UpdateFormats:
1088 if (f->name() == buf->params().getDefaultOutputFormat()) {
1089 docstring lbl = (kind == MenuItem::ViewFormats
1090 ? bformat(_("View [%1$s]|V"), label)
1091 : bformat(_("Update [%1$s]|U"), label));
1092 add(MenuItem(MenuItem::Command, toqstr(lbl), FuncRequest(action)));
1096 case MenuItem::ExportFormats:
1097 if (!f->inExportMenu())
1101 // we already asserted earlier in this case
1105 if (!shortcut.empty())
1106 label += '|' + shortcut;
1109 // note that at this point, we know that buf is not null
1111 item.submenu().addWithStatusCheck(MenuItem(MenuItem::Command,
1112 toqstr(label), FuncRequest(action, f->name())));
1115 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1116 FuncRequest(action, f->name())));
1118 add(MenuItem(MenuItem::Command, toqstr(label),
1119 FuncRequest(action, f->name())));
1127 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
1132 FloatList const & floats = buf->params().documentClass().floats();
1133 FloatList::const_iterator cit = floats.begin();
1134 FloatList::const_iterator end = floats.end();
1136 for (; cit != end; ++cit) {
1137 if (!cit->second.usesFloatPkg()) {
1138 // Different floats could declare the same ListCommand. We only
1139 // want it on the list once, though.
1140 string const & list_cmd = cit->second.listCommand();
1141 if (list_cmd.empty())
1142 // we do not know how to generate such a list
1144 // This form of insert returns an iterator pointing to the newly
1145 // inserted element OR the existing element with that value, and
1146 // a bool indicating whether we inserted a new element. So we can
1147 // see if one is there and insert it if not all at once.
1148 pair<set<string>::iterator, bool> ret = seen.insert(list_cmd);
1152 string const & list_name = cit->second.listName();
1153 addWithStatusCheck(MenuItem(MenuItem::Command, qt_(list_name),
1154 FuncRequest(LFUN_FLOAT_LIST_INSERT, cit->second.floattype())));
1159 void MenuDefinition::expandFloatInsert(Buffer const * buf)
1164 FloatList const & floats = buf->params().documentClass().floats();
1165 FloatList::const_iterator cit = floats.begin();
1166 FloatList::const_iterator end = floats.end();
1167 for (; cit != end; ++cit) {
1169 QString const label = qt_(cit->second.name());
1170 addWithStatusCheck(MenuItem(MenuItem::Command, label,
1171 FuncRequest(LFUN_FLOAT_INSERT,
1172 cit->second.floattype())));
1177 void MenuDefinition::expandFlexInsert(
1178 Buffer const * buf, InsetLayout::InsetLyXType type)
1183 TextClass::InsetLayouts const & insetLayouts =
1184 buf->params().documentClass().insetLayouts();
1185 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
1186 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
1187 for (; cit != end; ++cit) {
1188 if (cit->second.lyxtype() == type) {
1189 if (!cit->second.obsoleted_by().empty())
1191 docstring label = cit->first;
1192 // we remove the "Flex:" prefix, if it is present
1193 if (prefixIs(label, from_ascii("Flex:")))
1194 label = label.substr(5);
1195 addWithStatusCheck(MenuItem(MenuItem::Command,
1196 toqstr(translateIfPossible(label)),
1197 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(label))));
1200 // FIXME This is a little clunky.
1201 if (items_.empty() && type == InsetLayout::CUSTOM && !buf->isReadonly())
1202 add(MenuItem(MenuItem::Help, qt_("No Custom Insets Defined!")));
1206 // Threshold before we stop displaying sub-items alongside items
1207 // (for display purposes). Ideally this should fit on a screen.
1208 size_t const max_number_of_items = 30;
1209 // Size limit for the menu. This is for performance purposes,
1210 // because qt already displays a scrollable menu when necessary.
1211 // Ideally this should be the menu size from which scrollable
1212 // menus become unpractical.
1213 size_t const menu_size_limit = 80;
1215 void MenuDefinition::expandToc2(Toc const & toc_list,
1216 size_t from, size_t to, int depth,
1219 int shortcut_count = 0;
1221 // check whether depth is smaller than the smallest depth in toc.
1222 int min_depth = 1000;
1223 for (size_t i = from; i < to; ++i)
1224 min_depth = min(min_depth, toc_list[i].depth());
1225 if (min_depth > depth)
1228 if (to - from <= max_number_of_items) {
1229 for (size_t i = from; i < to; ++i) {
1230 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
1231 label += limitStringLength(toc_list[i].asString());
1232 if (toc_list[i].depth() == depth) {
1234 if (shortcut_count < 9) {
1235 if (label.contains(QString::number(shortcut_count + 1)))
1236 label += QString::number(++shortcut_count);
1239 add(MenuItem(MenuItem::Command, label,
1240 FuncRequest(toc_list[i].action())));
1241 // separator after the menu heading
1242 if (toc_list[i].depth() < depth)
1243 add(MenuItem(MenuItem::Separator));
1249 size_t new_pos = pos + 1;
1250 while (new_pos < to && toc_list[new_pos].depth() > depth)
1253 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
1254 label += limitStringLength(toc_list[pos].asString());
1255 if (toc_list[pos].depth() == depth) {
1257 if (shortcut_count < 9) {
1258 if (label.contains(QString::number(shortcut_count + 1)))
1259 label += QString::number(++shortcut_count);
1262 if (size >= menu_size_limit) {
1263 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + toc_type);
1264 add(MenuItem(MenuItem::Command, "...", f));
1267 if (new_pos == pos + 1) {
1268 add(MenuItem(MenuItem::Command,
1269 label, FuncRequest(toc_list[pos].action())));
1272 sub.expandToc2(toc_list, pos, new_pos, depth + 1, toc_type);
1273 MenuItem item(MenuItem::Submenu, label);
1274 item.setSubmenu(sub);
1284 void MenuDefinition::expandToc(Buffer const * buf)
1286 // To make things very cleanly, we would have to pass buf to
1287 // all MenuItem constructors and to expandToc2. However, we
1288 // know that all the entries in a TOC will be have status_ ==
1289 // OK, so we avoid this unnecessary overhead (JMarc)
1291 add(MenuItem(MenuItem::Info, qt_("(No Document Open)")));
1294 // Add an entry for the master doc if this is a child doc
1295 Buffer const * const master = buf->masterBuffer();
1296 if (buf != master) {
1297 ParIterator const pit = par_iterator_begin(master->inset());
1298 string const arg = convert<string>(pit->id());
1299 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
1300 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
1303 MenuDefinition other_lists;
1304 FloatList const & floatlist = buf->params().documentClass().floats();
1305 TocList const & toc_list = buf->tocBackend().tocs();
1306 TocList::const_iterator cit = toc_list.begin();
1307 TocList::const_iterator end = toc_list.end();
1308 for (; cit != end; ++cit) {
1309 // Handle table of contents later
1310 if (cit->first == "tableofcontents" || cit->second->empty())
1312 MenuDefinition submenu;
1313 // "Open outliner..." entry
1314 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
1315 submenu.add(MenuItem(MenuItem::Command, qt_("Open Outliner..."), f));
1316 submenu.add(MenuItem(MenuItem::Separator));
1318 submenu.expandToc2(*cit->second, 0, cit->second->size(), 0, cit->first);
1319 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
1320 item.setSubmenu(submenu);
1321 // deserves to be in the main menu?
1322 if (floatlist.typeExist(cit->first) || cit->first == "child")
1325 other_lists.add(item);
1327 if (!other_lists.empty()) {
1328 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
1329 item.setSubmenu(other_lists);
1332 // Handle normal TOC
1333 add(MenuItem(MenuItem::Separator));
1334 cit = toc_list.find("tableofcontents");
1336 LYXERR(Debug::GUI, "No table of contents.");
1338 if (!cit->second->empty())
1339 expandToc2(*cit->second, 0, cit->second->size(), 0,
1342 add(MenuItem(MenuItem::Info, qt_("(Empty Table of Contents)")));
1347 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1349 docstring_list const sel = cap::availableSelections(buf);
1351 docstring_list::const_iterator cit = sel.begin();
1352 docstring_list::const_iterator end = sel.end();
1354 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1355 add(MenuItem(MenuItem::Command, toqstr(*cit) + '|',
1356 FuncRequest(LFUN_PASTE, convert<string>(index))));
1361 void MenuDefinition::expandToolbars()
1363 MenuDefinition other_lists;
1364 // extracts the toolbars from the backend
1365 Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1366 Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1367 for (; cit != end; ++cit) {
1368 MenuItem const item(MenuItem::Command, toqstr(cit->gui_name),
1369 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1370 if (guiApp->toolbars().isMainToolbar(cit->name))
1373 other_lists.add(item);
1376 if (!other_lists.empty()) {
1377 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1378 item.setSubmenu(other_lists);
1384 void MenuDefinition::expandBranches(Buffer const * buf)
1386 if (!buf || buf->isReadonly())
1389 BufferParams const & master_params = buf->masterBuffer()->params();
1390 BufferParams const & params = buf->params();
1391 if (params.branchlist().empty() && master_params.branchlist().empty() ) {
1392 add(MenuItem(MenuItem::Help, qt_("No Branches Set for Document!")));
1396 BranchList::const_iterator cit = master_params.branchlist().begin();
1397 BranchList::const_iterator end = master_params.branchlist().end();
1399 for (int ii = 1; cit != end; ++cit, ++ii) {
1400 docstring label = cit->branch();
1402 label = convert<docstring>(ii) + ". " + label
1403 + char_type('|') + convert<docstring>(ii);
1405 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1406 FuncRequest(LFUN_BRANCH_INSERT,
1410 if (buf == buf->masterBuffer())
1413 MenuDefinition child_branches;
1415 BranchList::const_iterator ccit = params.branchlist().begin();
1416 BranchList::const_iterator cend = params.branchlist().end();
1418 for (int ii = 1; ccit != cend; ++ccit, ++ii) {
1419 docstring label = ccit->branch();
1421 label = convert<docstring>(ii) + ". " + label
1422 + char_type('|') + convert<docstring>(ii);
1424 label += char_type('|');
1425 child_branches.addWithStatusCheck(MenuItem(MenuItem::Command,
1427 FuncRequest(LFUN_BRANCH_INSERT,
1431 if (!child_branches.empty()) {
1432 MenuItem item(MenuItem::Submenu, qt_("Child Document"));
1433 item.setSubmenu(child_branches);
1439 void MenuDefinition::expandIndices(Buffer const * buf, bool listof)
1444 BufferParams const & params = buf->masterBuffer()->params();
1445 if (!params.use_indices) {
1447 addWithStatusCheck(MenuItem(MenuItem::Command,
1448 qt_("Index List|I"),
1449 FuncRequest(LFUN_INDEX_PRINT,
1450 from_ascii("idx"))));
1452 addWithStatusCheck(MenuItem(MenuItem::Command,
1453 qt_("Index Entry|d"),
1454 FuncRequest(LFUN_INDEX_INSERT,
1455 from_ascii("idx"))));
1459 if (params.indiceslist().empty())
1462 IndicesList::const_iterator cit = params.indiceslist().begin();
1463 IndicesList::const_iterator end = params.indiceslist().end();
1465 for (int ii = 1; cit != end; ++cit, ++ii) {
1467 docstring const label =
1468 bformat(_("Index: %1$s"), cit->index());
1469 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1470 FuncRequest(LFUN_INDEX_PRINT, cit->shortcut())));
1472 docstring const label =
1473 bformat(_("Index Entry (%1$s)"), cit->index());
1474 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1475 FuncRequest(LFUN_INDEX_INSERT, cit->shortcut())));
1481 void MenuDefinition::expandIndicesContext(Buffer const * buf, bool listof)
1486 BufferParams const & params = buf->masterBuffer()->params();
1487 if (!params.use_indices || params.indiceslist().empty())
1490 IndicesList::const_iterator cit = params.indiceslist().begin();
1491 IndicesList::const_iterator end = params.indiceslist().end();
1493 for (int ii = 1; cit != end; ++cit, ++ii) {
1495 InsetCommandParams p(INDEX_PRINT_CODE);
1496 p["type"] = cit->shortcut();
1497 string const data = InsetCommand::params2string(p);
1498 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
1499 FuncRequest(LFUN_INSET_MODIFY, data)));
1501 docstring const label =
1502 bformat(_("Index Entry (%1$s)"), cit->index());
1503 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1504 FuncRequest(LFUN_INSET_MODIFY,
1505 from_ascii("changetype ") + cit->shortcut())));
1511 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1516 Inset const * inset = bv->cursor().nextInset();
1517 if (!inset || inset->lyxCode() != CITE_CODE) {
1518 add(MenuItem(MenuItem::Command,
1519 qt_("No Citation in Scope!"),
1520 FuncRequest(LFUN_NOACTION)));
1523 InsetCommand const * citinset =
1524 static_cast<InsetCommand const *>(inset);
1526 Buffer const * buf = &bv->buffer();
1527 string const cmd = citinset->params().getCmdName();
1529 docstring const & key = citinset->getParam("key");
1531 add(MenuItem(MenuItem::Command,
1532 qt_("No citations selected!"),
1533 FuncRequest(LFUN_NOACTION)));
1537 docstring const & before = citinset->getParam("before");
1538 docstring const & after = citinset->getParam("after");
1540 size_t const n = cmd.size();
1541 bool const force = cmd[0] == 'C';
1542 bool const full = cmd[n] == '*';
1544 vector<docstring> const keys = getVectorFromString(key);
1546 vector<CitationStyle> const citeStyleList = buf->params().citeStyles();
1547 static const size_t max_length = 40;
1548 vector<docstring> citeStrings =
1549 buf->masterBibInfo().getCiteStrings(keys, citeStyleList, bv->buffer(),
1550 before, after, from_utf8("dialog"), max_length);
1552 vector<docstring>::const_iterator cit = citeStrings.begin();
1553 vector<docstring>::const_iterator end = citeStrings.end();
1555 for (int ii = 1; cit != end; ++cit, ++ii) {
1556 docstring label = *cit;
1557 CitationStyle cs = citeStyleList[ii - 1];
1558 cs.forceUpperCase &= force;
1559 cs.fullAuthorList &= full;
1560 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1561 FuncRequest(LFUN_INSET_MODIFY,
1562 "changetype " + from_utf8(citationStyleToString(cs)))));
1567 void MenuDefinition::expandArguments(BufferView const * bv, bool switcharg)
1572 if (!bv->cursor().inTexted())
1575 Inset const * inset = &bv->cursor().inset();
1576 Layout::LaTeXArgMap args = bv->cursor().paragraph().layout().args();
1577 if (inset && args.empty())
1578 args = inset->getLayout().args();
1579 if (args.empty() || (switcharg && args.size() == 1))
1581 Layout::LaTeXArgMap::const_iterator lait = args.begin();
1582 Layout::LaTeXArgMap::const_iterator const laend = args.end();
1583 for (; lait != laend; ++lait) {
1584 Layout::latexarg arg = (*lait).second;
1585 docstring str = arg.menustring.empty()? arg.labelstring : arg.menustring;
1586 QString item = toqstr(translateIfPossible(str));
1588 add(MenuItem(MenuItem::Command, item,
1589 FuncRequest(LFUN_INSET_MODIFY,
1590 from_ascii("changetype ")
1591 + from_ascii((*lait).first))));
1593 add(MenuItem(MenuItem::Command, item,
1594 FuncRequest(LFUN_ARGUMENT_INSERT,
1595 from_ascii((*lait).first))));
1600 void MenuDefinition::expandCaptions(Buffer const * buf, bool switchcap)
1605 DocumentClass const & dc = buf->params().documentClass();
1606 vector< pair<docstring, FuncRequest> > caps;
1607 for (pair<docstring, InsetLayout> const & il : dc.insetLayouts()) {
1609 docstring const type = split(il.first, instype, ':');
1610 if (instype == "Caption") {
1611 // skip forbidden caption types
1612 FuncRequest const cmd = switchcap
1613 ? FuncRequest(LFUN_INSET_MODIFY, from_ascii("changetype ") + type)
1614 : FuncRequest(LFUN_CAPTION_INSERT, type);
1615 if (getStatus(cmd).enabled())
1616 caps.push_back(make_pair(type, cmd));
1620 if (caps.empty() || (switchcap && caps.size() == 1))
1622 if (caps.size() == 1) {
1623 add(MenuItem(MenuItem::Command, qt_("Caption"), caps.front().second));
1627 MenuDefinition captions;
1628 for (pair<docstring, FuncRequest> const & cap : caps) {
1629 docstring const type = cap.first;
1630 docstring const trtype = translateIfPossible(type);
1631 docstring const cmitem = bformat(_("Caption (%1$s)"), trtype);
1633 add(MenuItem(MenuItem::Command, toqstr(cmitem), cap.second));
1635 captions.add(MenuItem(MenuItem::Command, toqstr(trtype), cap.second));
1637 if (!captions.empty()) {
1638 MenuItem item(MenuItem::Submenu, qt_("Caption"));
1639 item.setSubmenu(captions);
1645 void MenuDefinition::expandEnvironmentSeparators(BufferView const * bv)
1649 Text const * text = bv->cursor().text();
1650 // no paragraphs and no separators exist in math
1654 pit_type pit = bv->cursor().selBegin().pit();
1655 Paragraph const & par = text->getPar(pit);
1656 docstring const curlayout = par.layout().name();
1657 docstring outerlayout;
1658 depth_type current_depth = par.params().depth();
1659 // check if we have an environment in our nesting hierarchy
1660 Paragraph cpar = par;
1662 if (pit == 0 || cpar.params().depth() == 0)
1665 cpar = text->getPar(pit);
1666 if (cpar.params().depth() < current_depth
1667 && cpar.layout().isEnvironment()) {
1668 outerlayout = cpar.layout().name();
1669 current_depth = cpar.params().depth();
1672 if (par.layout().isEnvironment()) {
1673 docstring const label =
1674 bformat(_("Start New Environment (%1$s)"),
1675 translateIfPossible(curlayout));
1676 add(MenuItem(MenuItem::Command, toqstr(label),
1677 FuncRequest(LFUN_ENVIRONMENT_SPLIT)));
1679 if (!outerlayout.empty()) {
1680 docstring const label =
1681 bformat(_("Start New Parent Environment (%1$s)"),
1682 translateIfPossible(outerlayout));
1683 add(MenuItem(MenuItem::Command, toqstr(label),
1684 FuncRequest(LFUN_ENVIRONMENT_SPLIT,
1685 from_ascii("outer"))));
1692 /////////////////////////////////////////////////////////////////////
1693 // Menu::Impl definition and implementation
1694 /////////////////////////////////////////////////////////////////////
1698 /// populates the menu or one of its submenu
1699 /// This is used as a recursive function
1700 void populate(QMenu * qMenu, MenuDefinition const & menu);
1702 /// Only needed for top level menus.
1703 MenuDefinition * top_level_menu;
1706 /// the name of this menu
1712 /// Get a MenuDefinition item label from the menu backend
1713 static QString label(MenuItem const & mi)
1715 QString label = mi.label();
1716 label.replace("&", "&&");
1718 QString shortcut = mi.shortcut();
1719 if (!shortcut.isEmpty()) {
1720 int pos = label.indexOf(shortcut);
1722 //label.insert(pos, 1, char_type('&'));
1723 label.replace(pos, 0, "&");
1726 QString const binding = mi.binding();
1727 if (!binding.isEmpty())
1728 label += '\t' + binding;
1733 void Menu::Impl::populate(QMenu * qMenu, MenuDefinition const & menu)
1735 LYXERR(Debug::GUI, "populating menu " << menu.name());
1737 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
1740 LYXERR(Debug::GUI, " ***** menu entries " << menu.size());
1741 for (MenuItem const & m : menu)
1743 case MenuItem::Separator:
1744 qMenu->addSeparator();
1746 case MenuItem::Submenu: {
1747 QMenu * subMenu = qMenu->addMenu(label(m));
1748 populate(subMenu, m.submenu());
1749 subMenu->setEnabled(!subMenu->isEmpty());
1752 case MenuItem::Command:
1754 // FIXME: A previous comment assured that MenuItem::Command was the
1755 // only possible case in practice, but this is wrong. It would be
1756 // good to document which cases are actually treated here.
1757 qMenu->addAction(new Action(m.func(), QIcon(), label(m),
1758 m.tooltip(), qMenu));
1763 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
1764 class AlwaysMnemonicStyle : public QProxyStyle {
1766 int styleHint(StyleHint hint, const QStyleOption *opt = 0, const QWidget *widget = 0,
1767 QStyleHintReturn *returnData = 0) const
1769 if (hint == QStyle::SH_UnderlineShortcut)
1771 return QProxyStyle::styleHint(hint, opt, widget, returnData);
1776 /////////////////////////////////////////////////////////////////////
1777 // Menu implementation
1778 /////////////////////////////////////////////////////////////////////
1780 Menu::Menu(GuiView * gv, QString const & name, bool top_level, bool keyboard)
1781 : QMenu(gv), d(new Menu::Impl)
1783 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
1785 setStyle(new AlwaysMnemonicStyle);
1789 d->top_level_menu = top_level? new MenuDefinition : 0;
1793 if (d->top_level_menu)
1794 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1800 delete d->top_level_menu;
1805 void Menu::updateView()
1807 guiApp->menus().updateMenu(this);
1813 QList<QAction *> items = actions();
1814 for (int i = 0; i != items.size(); ++i) {
1815 // QAction::menu() returns 0 if there's no submenu.
1816 delete items.at(i)->menu();
1822 /////////////////////////////////////////////////////////////////////
1823 // Menus::Impl definition and implementation
1824 /////////////////////////////////////////////////////////////////////
1826 struct Menus::Impl {
1828 bool hasMenu(QString const &) const;
1830 MenuDefinition & getMenu(QString const &);
1832 MenuDefinition const & getMenu(QString const &) const;
1834 /// Expands some special entries of the menu
1835 /** The entries with the following kind are expanded to a
1836 sequence of Command MenuItems: Lastfiles, Documents,
1837 ViewFormats, ExportFormats, UpdateFormats, Branches,
1838 Indices, Arguments, SwitchArguments, Captions, SwitchCaptions,
1839 EnvironmentSeparators
1841 void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1842 BufferView const *) const;
1844 /// Initialize specific MACOS X menubar
1845 void macxMenuBarInit(QMenuBar * qmb);
1847 /// Mac special menu.
1848 /** This defines a menu whose entries list the FuncRequests
1849 that will be removed by expand() in other menus. This is
1850 used by the Qt/Mac code.
1852 NOTE: Qt does not remove the menu items when clearing a QMenuBar,
1853 such that the items will keep accessing the FuncRequests in
1854 the MenuDefinition. While Menus::Impl might be recreated,
1855 we keep mac_special_menu_ in memory by making it static.
1857 static MenuDefinition mac_special_menu_;
1862 MenuDefinition menubar_;
1864 typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
1866 /// name to menu for \c menu() method.
1871 MenuDefinition Menus::Impl::mac_special_menu_;
1875 Here is what the Qt documentation says about how a menubar is chosen:
1877 1) If the window has a QMenuBar then it is used. 2) If the window
1878 is a modal then its menubar is used. If no menubar is specified
1879 then a default menubar is used (as documented below) 3) If the
1880 window has no parent then the default menubar is used (as
1883 The above 3 steps are applied all the way up the parent window
1884 chain until one of the above are satisifed. If all else fails a
1885 default menubar will be created, the default menubar on Qt/Mac is
1886 an empty menubar, however you can create a different default
1887 menubar by creating a parentless QMenuBar, the first one created
1888 will thus be designated the default menubar, and will be used
1889 whenever a default menubar is needed.
1891 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1892 that this menubar will be used also when one of LyX' dialogs has
1895 void Menus::Impl::macxMenuBarInit(QMenuBar * qmb)
1897 /* Since Qt 4.2, the qt/mac menu code has special code for
1898 specifying the role of a menu entry. However, it does not
1899 work very well with our scheme of creating menus on demand,
1900 and therefore we need to put these entries in a special
1901 invisible menu. (JMarc)
1904 /* The entries of our special mac menu. If we add support for
1905 * special entries in Menus, we could imagine something
1907 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
1908 * and therefore avoid hardcoding. I am not sure it is worth
1909 * the hassle, though. (JMarc)
1911 struct MacMenuEntry {
1915 QAction::MenuRole role;
1918 static const MacMenuEntry entries[] = {
1919 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1920 QAction::AboutRole},
1921 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1922 QAction::PreferencesRole},
1923 #if !(defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
1924 /* This doesn't work with Cocoa. */
1925 {LFUN_RECONFIGURE, "", "Reconfigure",
1926 QAction::ApplicationSpecificRole},
1928 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1930 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1931 const bool first_call = mac_special_menu_.empty();
1933 LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
1934 // the special menu for Menus. Fill it up only once.
1936 for (size_t i = 0 ; i < num_entries ; ++i) {
1937 FuncRequest const func(entries[i].action,
1938 from_utf8(entries[i].arg));
1939 mac_special_menu_.add(MenuItem(MenuItem::Command,
1940 entries[i].label, func));
1944 // add the entries to a QMenu that will eventually be empty
1945 // and therefore invisible.
1946 QMenu * qMenu = qmb->addMenu("special");
1948 for (MenuItem const & m : mac_special_menu_) {
1949 Action * action = new Action(m.func(), QIcon(), m.label(),
1951 action->setMenuRole(entries[i].role);
1952 qMenu->addAction(action);
1958 void Menus::Impl::expand(MenuDefinition const & frommenu,
1959 MenuDefinition & tomenu, BufferView const * bv) const
1961 if (!tomenu.empty())
1964 for (MenuDefinition::const_iterator cit = frommenu.begin();
1965 cit != frommenu.end() ; ++cit) {
1966 Buffer const * buf = bv ? &bv->buffer() : 0;
1967 switch (cit->kind()) {
1968 case MenuItem::Lastfiles:
1969 tomenu.expandLastfiles();
1972 case MenuItem::Documents:
1973 tomenu.expandDocuments();
1976 case MenuItem::Bookmarks:
1977 tomenu.expandBookmarks();
1980 case MenuItem::ImportFormats:
1981 case MenuItem::ViewFormats:
1982 case MenuItem::UpdateFormats:
1983 case MenuItem::ExportFormats:
1984 tomenu.expandFormats(cit->kind(), buf);
1987 case MenuItem::CharStyles:
1988 tomenu.expandFlexInsert(buf, InsetLayout::CHARSTYLE);
1991 case MenuItem::Custom:
1992 tomenu.expandFlexInsert(buf, InsetLayout::CUSTOM);
1995 case MenuItem::Elements:
1996 tomenu.expandFlexInsert(buf, InsetLayout::ELEMENT);
1999 case MenuItem::FloatListInsert:
2000 tomenu.expandFloatListInsert(buf);
2003 case MenuItem::FloatInsert:
2004 tomenu.expandFloatInsert(buf);
2007 case MenuItem::PasteRecent:
2008 tomenu.expandPasteRecent(buf);
2011 case MenuItem::Toolbars:
2012 tomenu.expandToolbars();
2015 case MenuItem::Branches:
2016 tomenu.expandBranches(buf);
2019 case MenuItem::Indices:
2020 tomenu.expandIndices(buf);
2023 case MenuItem::IndicesContext:
2024 tomenu.expandIndicesContext(buf);
2027 case MenuItem::IndicesLists:
2028 tomenu.expandIndices(buf, true);
2031 case MenuItem::IndicesListsContext:
2032 tomenu.expandIndicesContext(buf, true);
2035 case MenuItem::CiteStyles:
2036 tomenu.expandCiteStyles(bv);
2040 tomenu.expandToc(buf);
2043 case MenuItem::GraphicsGroups:
2044 tomenu.expandGraphicsGroups(bv);
2047 case MenuItem::SpellingSuggestions:
2048 tomenu.expandSpellingSuggestions(bv);
2051 case MenuItem::LanguageSelector:
2052 tomenu.expandLanguageSelector(buf);
2055 case MenuItem::Arguments:
2056 tomenu.expandArguments(bv, false);
2059 case MenuItem::SwitchArguments:
2060 tomenu.expandArguments(bv, true);
2063 case MenuItem::Captions:
2064 tomenu.expandCaptions(buf, false);
2067 case MenuItem::SwitchCaptions:
2068 tomenu.expandCaptions(buf, true);
2071 case MenuItem::EnvironmentSeparators:
2072 tomenu.expandEnvironmentSeparators(bv);
2075 case MenuItem::Submenu: {
2076 MenuItem item(*cit);
2077 item.setSubmenu(MenuDefinition(cit->submenuname()));
2078 expand(getMenu(cit->submenuname()), item.submenu(), bv);
2079 tomenu.addWithStatusCheck(item);
2083 case MenuItem::Info:
2084 case MenuItem::Help:
2085 case MenuItem::Separator:
2086 tomenu.addWithStatusCheck(*cit);
2089 case MenuItem::Command:
2090 if (!mac_special_menu_.hasFunc(*cit->func()))
2091 tomenu.addWithStatusCheck(*cit);
2095 // we do not want the menu to end with a separator
2096 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
2097 tomenu.items_.pop_back();
2099 // Check whether the shortcuts are unique
2100 tomenu.checkShortcuts();
2104 bool Menus::Impl::hasMenu(QString const & name) const
2106 return find_if(menulist_.begin(), menulist_.end(),
2107 MenuNamesEqual(name)) != menulist_.end();
2111 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
2113 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
2114 MenuNamesEqual(name));
2115 if (cit == menulist_.end()) {
2116 LYXERR0("No submenu named " << name);
2117 LASSERT(false, { static const MenuDefinition m; return m; });
2123 MenuDefinition & Menus::Impl::getMenu(QString const & name)
2125 iterator it = find_if(menulist_.begin(), menulist_.end(),
2126 MenuNamesEqual(name));
2127 if (it == menulist_.end()) {
2128 LYXERR0("No submenu named " << name);
2129 LASSERT(false, { static MenuDefinition m; return m; });
2135 /////////////////////////////////////////////////////////////////////
2139 /////////////////////////////////////////////////////////////////////
2141 Menus::Menus() : d(new Impl) {}
2157 void Menus::read(Lexer & lex)
2165 LexerKeyword menutags[] = {
2166 { "end", md_endmenuset },
2167 { "menu", md_menu },
2168 { "menubar", md_menubar }
2171 // consistency check
2172 if (compare_ascii_no_case(lex.getString(), "menuset"))
2173 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
2175 lex.pushTable(menutags);
2176 lex.setContext("Menus::read");
2180 while (lex.isOK() && !quit) {
2181 switch (lex.lex()) {
2183 d->menubar_.read(lex);
2187 QString const name = toqstr(lex.getDocString());
2188 if (d->hasMenu(name))
2189 d->getMenu(name).read(lex);
2191 MenuDefinition menu(name);
2193 d->menulist_.push_back(menu);
2201 lex.printError("Unknown menu tag");
2209 bool Menus::searchMenu(FuncRequest const & func,
2210 docstring_list & names) const
2212 MenuDefinition menu;
2213 d->expand(d->menubar_, menu, 0);
2214 return menu.searchMenu(func, names);
2218 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
2222 // setup special mac specific menu items, but only do this
2223 // the first time a QMenuBar is created. Otherwise Qt will
2224 // create duplicate items in the application menu. It seems
2225 // that Qt does not remove them when the QMenubar is cleared.
2226 d->macxMenuBarInit(qmb);
2229 // Clear all menubar contents before filling it.
2231 #if (QT_VERSION >= 0x050000 && defined(Q_OS_MAC))
2232 d->macxMenuBarInit(qmb);
2236 LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
2238 if (d->menubar_.empty()) {
2239 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
2240 << d->menubar_.name());
2243 LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
2245 MenuDefinition menu;
2246 BufferView * bv = 0;
2248 bv = view->currentBufferView();
2249 d->expand(d->menubar_, menu, bv);
2251 MenuDefinition::const_iterator m = menu.begin();
2252 MenuDefinition::const_iterator end = menu.end();
2254 for (; m != end; ++m) {
2256 if (m->kind() != MenuItem::Submenu) {
2257 LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
2261 LYXERR(Debug::GUI, "menu bar item " << m->label()
2262 << " is a submenu named " << m->submenuname());
2264 QString name = m->submenuname();
2265 if (!d->hasMenu(name)) {
2266 LYXERR(Debug::GUI, "\tERROR: " << name
2267 << " submenu has no menu!");
2271 Menu * menu = new Menu(view, m->submenuname(), true);
2272 menu->setTitle(label(*m));
2274 #if defined(Q_OS_MAC) && (defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
2275 // On Mac OS with QT/cocoa, the menu is not displayed if there is no action
2276 // so we create a temporary one here
2277 QAction * action = new QAction(menu);
2278 menu->addAction(action);
2283 d->name_map_[view][name] = menu;
2288 void Menus::updateMenu(Menu * qmenu)
2290 LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
2293 if (qmenu->d->name.isEmpty())
2296 docstring identifier = qstring_to_ucs4(qmenu->d->name);
2297 MenuDefinition fromLyxMenu(qmenu->d->name);
2298 while (!identifier.empty()) {
2299 docstring menu_name;
2300 identifier = split(identifier, menu_name, ';');
2302 if (!d->hasMenu(toqstr(menu_name))) {
2303 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
2308 MenuDefinition cat_menu = d->getMenu(toqstr(menu_name));
2309 //FIXME: 50 is a wild guess. We should take into account here
2310 //the expansion of menu items, disabled optional items etc.
2311 bool const in_sub_menu = !fromLyxMenu.empty()
2312 && fromLyxMenu.size() + cat_menu.size() > 50 ;
2314 fromLyxMenu.catSub(menu_name);
2316 fromLyxMenu.cat(cat_menu);
2317 fromLyxMenu.add(MenuItem(MenuItem::Separator));
2320 if (fromLyxMenu.empty()) {
2321 qmenu->addAction(qt_("No Action Defined!"));
2325 BufferView * bv = 0;
2327 bv = qmenu->d->view->currentBufferView();
2328 d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
2329 qmenu->d->populate(qmenu, *qmenu->d->top_level_menu);
2333 Menu * Menus::menu(QString const & name, GuiView & view, bool keyboard)
2335 LYXERR(Debug::GUI, "Context menu requested: " << name);
2336 Menu * menu = d->name_map_[&view].value(name, 0);
2337 if (!menu && !name.startsWith("context-")) {
2338 LYXERR0("requested context menu not found: " << name);
2342 menu = new Menu(&view, name, true, keyboard);
2343 d->name_map_[&view][name] = menu;
2347 } // namespace frontend
2350 #include "moc_Menus.cpp"