3 * This file is part of LyX, the document processor.
4 * Licence details can be found in the file COPYING.
7 * \author Asger Alstrup
8 * \author Lars Gullik Bjønnes
9 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * \author Martin Vermeer
14 * Full author contact details are available in file CREDITS.
22 #include "GuiApplication.h"
24 #include "GuiWorkArea.h"
25 #include "qt_helpers.h"
27 #include "BiblioInfo.h"
28 #include "BranchList.h"
30 #include "BufferList.h"
31 #include "BufferParams.h"
32 #include "BufferView.h"
33 #include "Converter.h"
34 #include "CutAndPaste.h"
36 #include "FloatList.h"
38 #include "FuncRequest.h"
39 #include "FuncStatus.h"
40 #include "IndicesList.h"
45 #include "LyXAction.h"
49 #include "Paragraph.h"
50 #include "ParagraphParameters.h"
51 #include "ParIterator.h"
53 #include "SpellChecker.h"
54 #include "TextClass.h"
56 #include "TocBackend.h"
58 #include "WordLangTuple.h"
60 #include "insets/Inset.h"
61 #include "insets/InsetCitation.h"
62 #include "insets/InsetGraphics.h"
64 #include "support/lassert.h"
65 #include "support/convert.h"
66 #include "support/debug.h"
67 #include "support/docstring_list.h"
68 #include "support/filetools.h"
69 #include "support/gettext.h"
70 #include "support/lstrings.h"
77 #if QT_VERSION >= 0x040600
78 #include <QProxyStyle>
81 #include "support/shared_ptr.h"
87 using namespace lyx::support;
95 // MacOSX specific stuff is at the end.
102 /// The type of elements that can be in a menu
110 /** This type of item explains why something is unavailable. If this
111 menuitem is in a submenu, the submenu is enabled to make sure the
112 user sees the information. */
114 /** This type of item merely shows that there might be a list or
115 something alike at this position, but the list is still empty.
116 If this item is in a submenu, the submenu will not always be
119 /** This is the list of last opened file,
120 typically for the File menu. */
122 /** This is the list of opened Documents,
123 typically for the Documents menu. */
125 /** This is the bookmarks */
129 /** This is a list of viewable formats
130 typically for the File->View menu. */
132 /** This is a list of updatable formats
133 typically for the File->Update menu. */
135 /** This is a list of exportable formats
136 typically for the File->Export menu. */
138 /** This is a list of importable formats
139 typically for the File->Import menu. */
141 /** This is the list of elements available
142 * for insertion into document. */
144 /** This is the list of user-configurable
145 insets to insert into document */
147 /** This is the list of XML elements to
148 insert into the document */
150 /** This is the list of floats that we can
151 insert a list for. */
153 /** This is the list of floats that we can
156 /** This is the list of selections that can
161 /** Available branches in document */
163 /** Available indices in document */
165 /** Context menu for indices in document */
167 /** Available index lists in document */
169 /** Context menu for available indices lists in document */
171 /** Available citation styles for a given citation */
173 /** Available graphics groups */
175 /// Words suggested by the spellchecker.
177 /** Used Languages */
179 /** This is the list of arguments available
180 for insertion into the current layout. */
182 /** This is the list of arguments available
183 in the InsetArgument context menu. */
185 /** This is the list of captions available
186 in the current layout. */
188 /** This is the list of captions available
189 in the InsetCaption context menu. */
191 /** Commands to separate environments. */
192 EnvironmentSeparators
195 explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
198 QString const & label,
199 QString const & submenu = QString(),
200 QString const & tooltip = QString(),
201 bool optional = false)
202 : kind_(kind), label_(label), submenuname_(submenu),
203 tooltip_(tooltip), optional_(optional)
205 LATTEST(kind == Submenu || kind == Help || kind == Info);
209 QString const & label,
210 FuncRequest const & func,
211 QString const & tooltip = QString(),
212 bool optional = false,
213 FuncRequest::Origin origin = FuncRequest::MENU)
214 : kind_(kind), label_(label), func_(func),
215 tooltip_(tooltip), optional_(optional)
217 func_.setOrigin(origin);
220 // shared_ptr<MenuDefinition> needs this apprently...
223 /// The label of a given menuitem
224 QString label() const
226 int const index = label_.lastIndexOf('|');
227 return index == -1 ? label_ : label_.left(index);
230 /// The keyboard shortcut (usually underlined in the entry)
231 QString shortcut() const
233 int const index = label_.lastIndexOf('|');
234 return index == -1 ? QString() : label_.mid(index + 1);
236 /// The complete label, with label and shortcut separated by a '|'
237 QString fulllabel() const { return label_; }
238 /// The kind of entry
239 Kind kind() const { return kind_; }
240 /// the action (if relevant)
241 FuncRequest const & func() const { return func_; }
243 QString const & tooltip() const { return tooltip_; }
244 /// returns true if the entry should be omitted when disabled
245 bool optional() const { return optional_; }
246 /// returns the status of the lfun associated with this entry
247 FuncStatus const & status() const { return status_; }
248 /// returns the status of the lfun associated with this entry
249 FuncStatus & status() { return status_; }
250 /// returns the status of the lfun associated with this entry
251 void status(FuncStatus const & status) { status_ = status; }
253 ///returns the binding associated to this action.
254 QString binding() const
256 if (kind_ != Command)
258 // Get the keys bound to this action, but keep only the
260 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
261 if (!bindings.empty())
262 return toqstr(bindings.begin()->print(KeySequence::ForGui));
264 LYXERR(Debug::KBMAP, "No binding for "
265 << lyxaction.getActionName(func_.action())
266 << '(' << func_.argument() << ')');
270 /// the description of the submenu (if relevant)
271 QString const & submenuname() const { return submenuname_; }
272 /// set the description of the submenu
273 void submenuname(QString const & name) { submenuname_ = name; }
275 bool hasSubmenu() const { return !submenu_.isEmpty(); }
277 MenuDefinition const & submenu() const { return submenu_.at(0); }
278 MenuDefinition & submenu() { return submenu_[0]; }
280 void setSubmenu(MenuDefinition const & menu)
283 submenu_.append(menu);
294 QString submenuname_;
301 /// contains 0 or 1 item.
302 QList<MenuDefinition> submenu_;
306 class MenuDefinition {
309 typedef std::vector<MenuItem> ItemList;
311 typedef ItemList::const_iterator const_iterator;
313 explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
318 QString const & name() const { return name_; }
320 bool empty() const { return items_.empty(); }
321 /// Clear the menu content.
322 void clear() { items_.clear(); }
324 size_t size() const { return items_.size(); }
326 MenuItem const & operator[](size_t) const;
328 const_iterator begin() const { return items_.begin(); }
330 const_iterator end() const { return items_.end(); }
332 void cat(MenuDefinition const & other);
334 void catSub(docstring const & name);
336 // search for func in this menu iteratively, and put menu
338 bool searchMenu(FuncRequest const & func, docstring_list & names)
341 bool hasFunc(FuncRequest const &) const;
342 /// Add the menu item unconditionally
343 void add(MenuItem const & item) { items_.push_back(item); }
344 /// Checks the associated FuncRequest status before adding the
346 void addWithStatusCheck(MenuItem const &);
347 // Check whether the menu shortcuts are unique
348 void checkShortcuts() const;
350 void expandLastfiles();
351 void expandDocuments();
352 void expandBookmarks();
353 void expandFormats(MenuItem::Kind const kind, Buffer const * buf);
354 void expandFloatListInsert(Buffer const * buf);
355 void expandFloatInsert(Buffer const * buf);
356 void expandFlexInsert(Buffer const * buf, InsetLayout::InsetLyXType type);
357 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth, string toc_type);
358 void expandToc(Buffer const * buf);
359 void expandPasteRecent(Buffer const * buf);
360 void expandToolbars();
361 void expandBranches(Buffer const * buf);
362 void expandIndices(Buffer const * buf, bool listof = false);
363 void expandIndicesContext(Buffer const * buf, bool listof = false);
364 void expandCiteStyles(BufferView const *);
365 void expandGraphicsGroups(BufferView const *);
366 void expandSpellingSuggestions(BufferView const *);
367 void expandLanguageSelector(Buffer const * buf);
368 void expandArguments(BufferView const *, bool switcharg = false);
369 void expandCaptions(Buffer const * buf, bool switchcap = false);
370 void expandEnvironmentSeparators(BufferView const *);
378 /// Helper for std::find_if
382 MenuNamesEqual(QString const & name) : name_(name) {}
383 bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
390 typedef std::vector<MenuDefinition> MenuList;
392 typedef MenuList::const_iterator const_iterator;
394 typedef MenuList::iterator iterator;
396 /////////////////////////////////////////////////////////////////////
397 // MenuDefinition implementation
398 /////////////////////////////////////////////////////////////////////
400 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
404 case MenuItem::Command: {
405 FuncStatus status = lyx::getStatus(i.func());
406 if (status.unknown() || (!status.enabled() && i.optional()))
409 items_.back().status(status);
413 case MenuItem::Submenu: {
414 bool enabled = false;
415 if (i.hasSubmenu()) {
416 for (const_iterator cit = i.submenu().begin();
417 cit != i.submenu().end(); ++cit) {
418 // Only these kind of items affect the status of the submenu
419 if ((cit->kind() == MenuItem::Command
420 || cit->kind() == MenuItem::Submenu
421 || cit->kind() == MenuItem::Help)
422 && cit->status().enabled()) {
428 if (enabled || !i.optional()) {
430 items_.back().status().setEnabled(enabled);
435 case MenuItem::Separator:
436 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
446 void MenuDefinition::read(Lexer & lex)
463 md_indiceslistscontext,
477 md_spellingsuggestions,
486 LexerKeyword menutags[] = {
487 { "arguments", md_arguments },
488 { "bookmarks", md_bookmarks },
489 { "branches", md_branches },
490 { "captions", md_captions },
491 { "charstyles", md_charstyles },
492 { "citestyles", md_citestyles },
493 { "custom", md_custom },
494 { "documents", md_documents },
495 { "elements", md_elements },
496 { "end", md_endmenu },
497 { "environmentseparators", md_env_separators },
498 { "exportformats", md_exportformats },
499 { "floatinsert", md_floatinsert },
500 { "floatlistinsert", md_floatlistinsert },
501 { "graphicsgroups", md_graphicsgroups },
502 { "importformats", md_importformats },
503 { "indices", md_indices },
504 { "indicescontext", md_indicescontext },
505 { "indiceslists", md_indiceslists },
506 { "indiceslistscontext", md_indiceslistscontext },
508 { "languageselector", md_languageselector },
509 { "lastfiles", md_lastfiles },
510 { "optitem", md_optitem },
511 { "optsubmenu", md_optsubmenu },
512 { "pasterecent", md_pasterecent },
513 { "separator", md_separator },
514 { "spellingsuggestions", md_spellingsuggestions },
515 { "submenu", md_submenu },
516 { "switcharguments", md_switcharguments },
517 { "switchcaptions", md_switchcaptions },
519 { "toolbars", md_toolbars },
520 { "updateformats", md_updateformats },
521 { "viewformats", md_viewformats }
524 lex.pushTable(menutags);
525 lex.setContext("MenuDefinition::read: ");
528 while (lex.isOK() && md_type != md_endmenu) {
529 switch (md_type = lex.lex()) {
533 docstring const name = translateIfPossible(lex.getDocString());
535 string const command = lex.getString();
536 FuncRequest func = lyxaction.lookupFunc(command);
537 FuncRequest::Origin origin = FuncRequest::MENU;
538 if (name_.startsWith("context-toc-"))
539 origin = FuncRequest::TOC;
540 bool const optional = (md_type == md_optitem);
541 add(MenuItem(MenuItem::Command, toqstr(name), func, QString(), optional, origin));
546 add(MenuItem(MenuItem::Separator));
550 add(MenuItem(MenuItem::Lastfiles));
554 add(MenuItem(MenuItem::CharStyles));
558 add(MenuItem(MenuItem::Custom));
562 add(MenuItem(MenuItem::Elements));
566 add(MenuItem(MenuItem::Documents));
570 add(MenuItem(MenuItem::Bookmarks));
574 add(MenuItem(MenuItem::Toc));
578 add(MenuItem(MenuItem::ViewFormats));
581 case md_updateformats:
582 add(MenuItem(MenuItem::UpdateFormats));
585 case md_exportformats:
586 add(MenuItem(MenuItem::ExportFormats));
589 case md_importformats:
590 add(MenuItem(MenuItem::ImportFormats));
593 case md_floatlistinsert:
594 add(MenuItem(MenuItem::FloatListInsert));
598 add(MenuItem(MenuItem::FloatInsert));
602 add(MenuItem(MenuItem::PasteRecent));
606 add(MenuItem(MenuItem::Toolbars));
610 add(MenuItem(MenuItem::Branches));
614 add(MenuItem(MenuItem::CiteStyles));
617 case md_graphicsgroups:
618 add(MenuItem(MenuItem::GraphicsGroups));
621 case md_spellingsuggestions:
622 add(MenuItem(MenuItem::SpellingSuggestions));
625 case md_languageselector:
626 add(MenuItem(MenuItem::LanguageSelector));
630 add(MenuItem(MenuItem::Indices));
633 case md_indicescontext:
634 add(MenuItem(MenuItem::IndicesContext));
637 case md_indiceslists:
638 add(MenuItem(MenuItem::IndicesLists));
641 case md_indiceslistscontext:
642 add(MenuItem(MenuItem::IndicesListsContext));
646 add(MenuItem(MenuItem::Arguments));
649 case md_switcharguments:
650 add(MenuItem(MenuItem::SwitchArguments));
654 add(MenuItem(MenuItem::Captions));
657 case md_switchcaptions:
658 add(MenuItem(MenuItem::SwitchCaptions));
661 case md_env_separators:
662 add(MenuItem(MenuItem::EnvironmentSeparators));
668 docstring const mlabel = translateIfPossible(lex.getDocString());
670 docstring const mname = lex.getDocString();
671 bool const optional = (md_type == md_optsubmenu);
672 add(MenuItem(MenuItem::Submenu,
673 toqstr(mlabel), toqstr(mname), QString(), optional));
681 lex.printError("Unknown menu tag");
689 MenuItem const & MenuDefinition::operator[](size_type i) const
695 bool MenuDefinition::hasFunc(FuncRequest const & func) const
697 for (const_iterator it = begin(), et = end(); it != et; ++it)
698 if (it->func() == func)
704 void MenuDefinition::catSub(docstring const & name)
706 add(MenuItem(MenuItem::Submenu,
707 qt_("More...|M"), toqstr(name), QString(), false));
710 void MenuDefinition::cat(MenuDefinition const & other)
712 const_iterator et = other.end();
713 for (const_iterator it = other.begin(); it != et; ++it)
718 void MenuDefinition::checkShortcuts() const
720 // This is a quadratic algorithm, but we do not care because
721 // menus are short enough
722 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
723 QString shortcut = it1->shortcut();
724 if (shortcut.isEmpty())
726 if (!it1->label().contains(shortcut))
727 LYXERR0("Menu warning: menu entry \""
729 << "\" does not contain shortcut `"
730 << shortcut << "'.");
731 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
732 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
733 LYXERR0("Menu warning: menu entries "
734 << '"' << it1->fulllabel()
735 << "\" and \"" << it2->fulllabel()
736 << "\" share the same shortcut.");
743 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
745 const_iterator m = begin();
746 const_iterator m_end = end();
747 for (; m != m_end; ++m) {
748 if (m->kind() == MenuItem::Command && m->func() == func) {
749 names.push_back(qstring_to_ucs4(m->label()));
752 if (m->kind() == MenuItem::Submenu) {
753 names.push_back(qstring_to_ucs4(m->label()));
754 if (!m->hasSubmenu()) {
755 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
756 << m->label() << " name=" << m->submenuname());
760 if (m->submenu().searchMenu(func, names))
769 QString limitStringLength(docstring const & str)
771 size_t const max_item_length = 45;
772 docstring ret = str.substr(0, max_item_length + 1);
773 support::truncateWithEllipsis(ret, max_item_length);
778 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
783 graphics::getGraphicsGroups(bv->buffer(), grp);
787 set<string>::const_iterator it = grp.begin();
788 set<string>::const_iterator end = grp.end();
789 add(MenuItem(MenuItem::Command, qt_("No Group"),
790 FuncRequest(LFUN_SET_GRAPHICS_GROUP)));
791 for (; it != end; ++it) {
792 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it) + '|',
793 FuncRequest(LFUN_SET_GRAPHICS_GROUP, *it)));
798 void MenuDefinition::expandSpellingSuggestions(BufferView const * bv)
802 Cursor const & cur = bv->cursor();
806 docstring_list suggestions;
807 Paragraph const & par = cur.paragraph();
808 pos_type from = cur.pos();
810 SpellChecker::Result res = par.spellCheck(from, to, wl, suggestions, true, true);
812 case SpellChecker::UNKNOWN_WORD:
813 if (lyxrc.spellcheck_continuously) {
814 LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
815 docstring const & selection = cur.selectionAsString(false);
816 if (!cur.selection() || selection == wl.word()) {
818 size_t m = 10; // first submenu index
819 MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
820 item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
821 for (; i != suggestions.size(); ++i) {
822 docstring const & suggestion = suggestions[i];
823 LYXERR(Debug::GUI, suggestion);
824 MenuItem w(MenuItem::Command, toqstr(suggestion),
825 FuncRequest(LFUN_WORD_REPLACE,
826 replace2string(suggestion, selection,
827 true, // case sensitive
831 false))); // find next
835 item.submenu().add(w);
840 add(MenuItem(MenuItem::Separator));
841 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
842 add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|n"),
843 FuncRequest(LFUN_SPELLING_ADD, arg)));
844 add(MenuItem(MenuItem::Command, qt_("Ignore all|I"),
845 FuncRequest(LFUN_SPELLING_IGNORE, arg)));
849 case SpellChecker::LEARNED_WORD: {
850 LYXERR(Debug::GUI, "Learned Word.");
851 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
852 add(MenuItem(MenuItem::Command, qt_("Remove from personal dictionary|r"),
853 FuncRequest(LFUN_SPELLING_REMOVE, arg)));
856 case SpellChecker::NO_DICTIONARY:
857 LYXERR(Debug::GUI, "No dictionary for language " + from_ascii(wl.lang()->lang()));
859 case SpellChecker::WORD_OK:
860 case SpellChecker::COMPOUND_WORD:
861 case SpellChecker::ROOT_FOUND:
862 case SpellChecker::IGNORED_WORD:
867 struct sortLanguageByName {
868 bool operator()(const Language * a, const Language * b) const {
869 return qt_(a->display()).localeAwareCompare(qt_(b->display())) < 0;
873 void MenuDefinition::expandLanguageSelector(Buffer const * buf)
878 std::set<Language const *> languages_buffer =
879 buf->masterBuffer()->getLanguages();
881 if (languages_buffer.size() < 2)
884 std::set<Language const *, sortLanguageByName> languages;
886 std::set<Language const *>::const_iterator const beg =
887 languages_buffer.begin();
888 for (std::set<Language const *>::const_iterator cit = beg;
889 cit != languages_buffer.end(); ++cit) {
890 languages.insert(*cit);
893 MenuItem item(MenuItem::Submenu, qt_("Language|L"));
894 item.setSubmenu(MenuDefinition(qt_("Language")));
895 QString morelangs = qt_("More Languages ...|M");
896 QStringList accelerators;
897 if (morelangs.contains('|'))
898 accelerators.append(morelangs.section('|', -1));
899 std::set<Language const *, sortLanguageByName>::const_iterator const begin = languages.begin();
900 for (std::set<Language const *, sortLanguageByName>::const_iterator cit = begin;
901 cit != languages.end(); ++cit) {
902 QString label = qt_((*cit)->display());
903 // try to add an accelerator
904 bool success = false;
905 // try capitals first
906 for (int i = 0; i < label.size(); ++i) {
907 QChar const ch = label[i];
910 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
911 label = label + toqstr("|") + ch;
912 accelerators.append(ch);
917 // if all capitals are taken, try the rest
919 for (int i = 0; i < label.size(); ++i) {
920 if (label[i].isSpace())
922 QString const ch = QString(label[i]);
923 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
924 label = label + toqstr("|") + ch;
925 accelerators.append(ch);
930 MenuItem w(MenuItem::Command, label,
931 FuncRequest(LFUN_LANGUAGE, (*cit)->lang() + " set"));
932 item.submenu().addWithStatusCheck(w);
934 item.submenu().add(MenuItem(MenuItem::Separator));
935 item.submenu().add(MenuItem(MenuItem::Command, morelangs,
936 FuncRequest(LFUN_DIALOG_SHOW, "character")));
941 void MenuDefinition::expandLastfiles()
943 LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
944 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
948 for (; lfit != lf.end() && ii <= lyxrc.num_lastfiles; ++lfit, ++ii) {
949 string const file = lfit->absFileName();
950 QString const short_path = toqstr(makeDisplayPath(file, 30));
951 QString const long_path = toqstr(makeDisplayPath(file));
954 label = QString("%1. %2|%3").arg(ii).arg(short_path).arg(ii);
956 label = QString("%1. %2").arg(ii).arg(short_path);
957 add(MenuItem(MenuItem::Command, label,
958 FuncRequest(LFUN_FILE_OPEN, file), long_path));
963 void MenuDefinition::expandDocuments()
965 MenuItem item(MenuItem::Submenu, qt_("Hidden|H"));
966 item.setSubmenu(MenuDefinition(qt_("Hidden|H")));
968 Buffer * first = theBufferList().first();
970 add(MenuItem(MenuItem::Info, qt_("<No Documents Open>")));
976 if (!guiApp->currentView())
978 GuiWorkArea * wa = guiApp->currentView()->workArea(i);
981 Buffer const & b = wa->bufferView().buffer();
982 QString label = toqstr(b.fileName().displayName(20));
986 label = QString::number(i) + ". " + label + '|' + QString::number(i);
987 add(MenuItem(MenuItem::Command, label,
988 FuncRequest(LFUN_BUFFER_SWITCH, b.absFileName())));
995 // We cannot use a for loop as the buffer list cycles.
997 if (!(guiApp->currentView()
998 && guiApp->currentView()->workArea(*b))) {
999 QString label = toqstr(b->fileName().displayName(20));
1003 label = QString::number(i) + ". " + label + '|' + QString::number(i);
1004 item.submenu().add(MenuItem(MenuItem::Command, label,
1005 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
1008 b = theBufferList().next(b);
1009 } while (b != first);
1011 if (!item.submenu().empty())
1016 void MenuDefinition::expandBookmarks()
1018 lyx::BookmarksSection const & bm = theSession().bookmarks();
1021 for (size_t i = 1; i <= bm.size(); ++i) {
1022 if (bm.isValid(i)) {
1023 string const file = bm.bookmark(i).filename.absFileName();
1024 QString const label = QString("%1. %2|%3").arg(i)
1025 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
1026 add(MenuItem(MenuItem::Command, label,
1027 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
1032 add(MenuItem(MenuItem::Info, qt_("<No Bookmarks Saved Yet>")));
1036 void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf)
1038 if (!buf && kind != MenuItem::ImportFormats)
1041 typedef vector<Format const *> Formats;
1043 FuncCode action = LFUN_NOACTION;
1046 case MenuItem::ImportFormats:
1047 formats = theConverters().importableFormats();
1048 action = LFUN_BUFFER_IMPORT;
1050 case MenuItem::ViewFormats:
1051 formats = buf->params().exportableFormats(true);
1052 action = LFUN_BUFFER_VIEW;
1054 case MenuItem::UpdateFormats:
1055 formats = buf->params().exportableFormats(true);
1056 action = LFUN_BUFFER_UPDATE;
1058 case MenuItem::ExportFormats:
1059 formats = buf->params().exportableFormats(false);
1060 action = LFUN_BUFFER_EXPORT;
1066 sort(formats.begin(), formats.end(), Format::formatSorter);
1068 bool const view_update = (kind == MenuItem::ViewFormats
1069 || kind == MenuItem::UpdateFormats);
1073 smenue = (kind == MenuItem::ViewFormats
1074 ? qt_("View (Other Formats)|F")
1075 : qt_("Update (Other Formats)|p"));
1076 MenuItem item(MenuItem::Submenu, smenue);
1077 item.setSubmenu(MenuDefinition(smenue));
1079 Formats::const_iterator fit = formats.begin();
1080 Formats::const_iterator end = formats.end();
1081 for (; fit != end ; ++fit) {
1082 if ((*fit)->dummy())
1085 docstring lab = from_utf8((*fit)->prettyname());
1086 docstring const scut = from_utf8((*fit)->shortcut());
1087 docstring const tmplab = lab;
1090 lab += char_type('|') + scut;
1091 docstring const lab_i18n = translateIfPossible(lab);
1092 docstring const shortcut = split(lab_i18n, lab, '|');
1094 bool const untranslated = (lab == lab_i18n);
1095 docstring label = untranslated ? translateIfPossible(tmplab) : lab;
1098 case MenuItem::ImportFormats:
1099 label += from_ascii("...");
1101 case MenuItem::ViewFormats:
1102 case MenuItem::UpdateFormats:
1103 if ((*fit)->name() == buf->params().getDefaultOutputFormat()) {
1104 docstring lbl = (kind == MenuItem::ViewFormats
1105 ? bformat(_("View [%1$s]|V"), label)
1106 : bformat(_("Update [%1$s]|U"), label));
1107 add(MenuItem(MenuItem::Command, toqstr(lbl), FuncRequest(action)));
1111 case MenuItem::ExportFormats:
1112 if (!(*fit)->inExportMenu())
1116 // we already asserted earlier in this case
1120 if (!shortcut.empty())
1121 label += '|' + shortcut;
1124 // note that at this point, we know that buf is not null
1126 item.submenu().addWithStatusCheck(MenuItem(MenuItem::Command,
1127 toqstr(label), FuncRequest(action, (*fit)->name())));
1130 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1131 FuncRequest(action, (*fit)->name())));
1133 add(MenuItem(MenuItem::Command, toqstr(label),
1134 FuncRequest(action, (*fit)->name())));
1142 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
1147 FloatList const & floats = buf->params().documentClass().floats();
1148 FloatList::const_iterator cit = floats.begin();
1149 FloatList::const_iterator end = floats.end();
1151 for (; cit != end; ++cit) {
1152 if (!cit->second.usesFloatPkg()) {
1153 // Different floats could declare the same ListCommand. We only
1154 // want it on the list once, though.
1155 string const & list_cmd = cit->second.listCommand();
1156 if (list_cmd.empty())
1157 // we do not know how to generate such a list
1159 // This form of insert returns an iterator pointing to the newly
1160 // inserted element OR the existing element with that value, and
1161 // a bool indicating whether we inserted a new element. So we can
1162 // see if one is there and insert it if not all at once.
1163 pair<set<string>::iterator, bool> ret = seen.insert(list_cmd);
1167 string const & list_name = cit->second.listName();
1168 addWithStatusCheck(MenuItem(MenuItem::Command, qt_(list_name),
1169 FuncRequest(LFUN_FLOAT_LIST_INSERT, cit->second.floattype())));
1174 void MenuDefinition::expandFloatInsert(Buffer const * buf)
1179 FloatList const & floats = buf->params().documentClass().floats();
1180 FloatList::const_iterator cit = floats.begin();
1181 FloatList::const_iterator end = floats.end();
1182 for (; cit != end; ++cit) {
1184 QString const label = qt_(cit->second.name());
1185 addWithStatusCheck(MenuItem(MenuItem::Command, label,
1186 FuncRequest(LFUN_FLOAT_INSERT,
1187 cit->second.floattype())));
1192 void MenuDefinition::expandFlexInsert(
1193 Buffer const * buf, InsetLayout::InsetLyXType type)
1198 TextClass::InsetLayouts const & insetLayouts =
1199 buf->params().documentClass().insetLayouts();
1200 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
1201 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
1202 for (; cit != end; ++cit) {
1203 if (cit->second.lyxtype() == type) {
1204 if (!cit->second.obsoleted_by().empty())
1206 docstring label = cit->first;
1207 // we remove the "Flex:" prefix, if it is present
1208 if (prefixIs(label, from_ascii("Flex:")))
1209 label = label.substr(5);
1210 addWithStatusCheck(MenuItem(MenuItem::Command,
1211 toqstr(translateIfPossible(label)),
1212 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(label))));
1215 // FIXME This is a little clunky.
1216 if (items_.empty() && type == InsetLayout::CUSTOM && !buf->isReadonly())
1217 add(MenuItem(MenuItem::Help, qt_("No Custom Insets Defined!")));
1221 // Threshold before we stop displaying sub-items alongside items
1222 // (for display purposes). Ideally this should fit on a screen.
1223 size_t const max_number_of_items = 30;
1224 // Size limit for the menu. This is for performance purposes,
1225 // because qt already displays a scrollable menu when necessary.
1226 // Ideally this should be the menu size from which scrollable
1227 // menus become unpractical.
1228 size_t const menu_size_limit = 80;
1230 void MenuDefinition::expandToc2(Toc const & toc_list,
1231 size_t from, size_t to, int depth,
1234 int shortcut_count = 0;
1236 // check whether depth is smaller than the smallest depth in toc.
1237 int min_depth = 1000;
1238 for (size_t i = from; i < to; ++i)
1239 min_depth = min(min_depth, toc_list[i].depth());
1240 if (min_depth > depth)
1243 if (to - from <= max_number_of_items) {
1244 for (size_t i = from; i < to; ++i) {
1245 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
1246 label += limitStringLength(toc_list[i].asString());
1247 if (toc_list[i].depth() == depth) {
1249 if (shortcut_count < 9) {
1250 if (label.contains(QString::number(shortcut_count + 1)))
1251 label += QString::number(++shortcut_count);
1254 add(MenuItem(MenuItem::Command, label,
1255 FuncRequest(toc_list[i].action())));
1256 // separator after the menu heading
1257 if (toc_list[i].depth() < depth)
1258 add(MenuItem(MenuItem::Separator));
1264 size_t new_pos = pos + 1;
1265 while (new_pos < to && toc_list[new_pos].depth() > depth)
1268 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
1269 label += limitStringLength(toc_list[pos].asString());
1270 if (toc_list[pos].depth() == depth) {
1272 if (shortcut_count < 9) {
1273 if (label.contains(QString::number(shortcut_count + 1)))
1274 label += QString::number(++shortcut_count);
1277 if (size >= menu_size_limit) {
1278 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + toc_type);
1279 add(MenuItem(MenuItem::Command, "...", f));
1282 if (new_pos == pos + 1) {
1283 add(MenuItem(MenuItem::Command,
1284 label, FuncRequest(toc_list[pos].action())));
1287 sub.expandToc2(toc_list, pos, new_pos, depth + 1, toc_type);
1288 MenuItem item(MenuItem::Submenu, label);
1289 item.setSubmenu(sub);
1299 void MenuDefinition::expandToc(Buffer const * buf)
1301 // To make things very cleanly, we would have to pass buf to
1302 // all MenuItem constructors and to expandToc2. However, we
1303 // know that all the entries in a TOC will be have status_ ==
1304 // OK, so we avoid this unnecessary overhead (JMarc)
1306 add(MenuItem(MenuItem::Info, qt_("(No Document Open)")));
1309 // Add an entry for the master doc if this is a child doc
1310 Buffer const * const master = buf->masterBuffer();
1311 if (buf != master) {
1312 ParIterator const pit = par_iterator_begin(master->inset());
1313 string const arg = convert<string>(pit->id());
1314 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
1315 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
1318 MenuDefinition other_lists;
1319 FloatList const & floatlist = buf->params().documentClass().floats();
1320 TocList const & toc_list = buf->tocBackend().tocs();
1321 TocList::const_iterator cit = toc_list.begin();
1322 TocList::const_iterator end = toc_list.end();
1323 for (; cit != end; ++cit) {
1324 // Handle table of contents later
1325 if (cit->first == "tableofcontents" || cit->second->empty())
1327 MenuDefinition submenu;
1328 // "Open outliner..." entry
1329 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
1330 submenu.add(MenuItem(MenuItem::Command, qt_("Open Outliner..."), f));
1331 submenu.add(MenuItem(MenuItem::Separator));
1333 submenu.expandToc2(*cit->second, 0, cit->second->size(), 0, cit->first);
1334 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
1335 item.setSubmenu(submenu);
1336 // deserves to be in the main menu?
1337 if (floatlist.typeExist(cit->first) || cit->first == "child")
1340 other_lists.add(item);
1342 if (!other_lists.empty()) {
1343 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
1344 item.setSubmenu(other_lists);
1347 // Handle normal TOC
1348 add(MenuItem(MenuItem::Separator));
1349 cit = toc_list.find("tableofcontents");
1351 LYXERR(Debug::GUI, "No table of contents.");
1353 if (!cit->second->empty())
1354 expandToc2(*cit->second, 0, cit->second->size(), 0,
1357 add(MenuItem(MenuItem::Info, qt_("(Empty Table of Contents)")));
1362 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1364 docstring_list const sel = cap::availableSelections(buf);
1366 docstring_list::const_iterator cit = sel.begin();
1367 docstring_list::const_iterator end = sel.end();
1369 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1370 add(MenuItem(MenuItem::Command, toqstr(*cit) + '|',
1371 FuncRequest(LFUN_PASTE, convert<string>(index))));
1376 void MenuDefinition::expandToolbars()
1378 MenuDefinition other_lists;
1379 // extracts the toolbars from the backend
1380 Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1381 Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1382 for (; cit != end; ++cit) {
1383 MenuItem const item(MenuItem::Command, toqstr(cit->gui_name),
1384 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1385 if (guiApp->toolbars().isMainToolbar(cit->name))
1388 other_lists.add(item);
1391 if (!other_lists.empty()) {
1392 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1393 item.setSubmenu(other_lists);
1399 void MenuDefinition::expandBranches(Buffer const * buf)
1401 if (!buf || buf->isReadonly())
1404 BufferParams const & master_params = buf->masterBuffer()->params();
1405 BufferParams const & params = buf->params();
1406 if (params.branchlist().empty() && master_params.branchlist().empty() ) {
1407 add(MenuItem(MenuItem::Help, qt_("No Branches Set for Document!")));
1411 BranchList::const_iterator cit = master_params.branchlist().begin();
1412 BranchList::const_iterator end = master_params.branchlist().end();
1414 for (int ii = 1; cit != end; ++cit, ++ii) {
1415 docstring label = cit->branch();
1417 label = convert<docstring>(ii) + ". " + label
1418 + char_type('|') + convert<docstring>(ii);
1420 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1421 FuncRequest(LFUN_BRANCH_INSERT,
1425 if (buf == buf->masterBuffer())
1428 MenuDefinition child_branches;
1430 BranchList::const_iterator ccit = params.branchlist().begin();
1431 BranchList::const_iterator cend = params.branchlist().end();
1433 for (int ii = 1; ccit != cend; ++ccit, ++ii) {
1434 docstring label = ccit->branch();
1436 label = convert<docstring>(ii) + ". " + label
1437 + char_type('|') + convert<docstring>(ii);
1439 label += char_type('|');
1440 child_branches.addWithStatusCheck(MenuItem(MenuItem::Command,
1442 FuncRequest(LFUN_BRANCH_INSERT,
1446 if (!child_branches.empty()) {
1447 MenuItem item(MenuItem::Submenu, qt_("Child Document"));
1448 item.setSubmenu(child_branches);
1454 void MenuDefinition::expandIndices(Buffer const * buf, bool listof)
1459 BufferParams const & params = buf->masterBuffer()->params();
1460 if (!params.use_indices) {
1462 addWithStatusCheck(MenuItem(MenuItem::Command,
1463 qt_("Index List|I"),
1464 FuncRequest(LFUN_INDEX_PRINT,
1465 from_ascii("idx"))));
1467 addWithStatusCheck(MenuItem(MenuItem::Command,
1468 qt_("Index Entry|d"),
1469 FuncRequest(LFUN_INDEX_INSERT,
1470 from_ascii("idx"))));
1474 if (params.indiceslist().empty())
1477 IndicesList::const_iterator cit = params.indiceslist().begin();
1478 IndicesList::const_iterator end = params.indiceslist().end();
1480 for (int ii = 1; cit != end; ++cit, ++ii) {
1482 docstring const label =
1483 bformat(_("Index: %1$s"), cit->index());
1484 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1485 FuncRequest(LFUN_INDEX_PRINT, cit->shortcut())));
1487 docstring const label =
1488 bformat(_("Index Entry (%1$s)"), cit->index());
1489 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1490 FuncRequest(LFUN_INDEX_INSERT, cit->shortcut())));
1496 void MenuDefinition::expandIndicesContext(Buffer const * buf, bool listof)
1501 BufferParams const & params = buf->masterBuffer()->params();
1502 if (!params.use_indices || params.indiceslist().empty())
1505 IndicesList::const_iterator cit = params.indiceslist().begin();
1506 IndicesList::const_iterator end = params.indiceslist().end();
1508 for (int ii = 1; cit != end; ++cit, ++ii) {
1510 InsetCommandParams p(INDEX_PRINT_CODE);
1511 p["type"] = cit->shortcut();
1512 string const data = InsetCommand::params2string(p);
1513 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
1514 FuncRequest(LFUN_INSET_MODIFY, data)));
1516 docstring const label =
1517 bformat(_("Index Entry (%1$s)"), cit->index());
1518 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1519 FuncRequest(LFUN_INSET_MODIFY,
1520 from_ascii("changetype ") + cit->shortcut())));
1526 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1531 Inset const * inset = bv->cursor().nextInset();
1532 if (!inset || inset->lyxCode() != CITE_CODE) {
1533 add(MenuItem(MenuItem::Command,
1534 qt_("No Citation in Scope!"),
1535 FuncRequest(LFUN_NOACTION)));
1538 InsetCommand const * citinset =
1539 static_cast<InsetCommand const *>(inset);
1541 Buffer const * buf = &bv->buffer();
1542 string const cmd = citinset->params().getCmdName();
1544 docstring const & key = citinset->getParam("key");
1546 add(MenuItem(MenuItem::Command,
1547 qt_("No citations selected!"),
1548 FuncRequest(LFUN_NOACTION)));
1552 docstring const & before = citinset->getParam("before");
1553 docstring const & after = citinset->getParam("after");
1555 size_t const n = cmd.size();
1556 bool const force = cmd[0] == 'C';
1557 bool const full = cmd[n] == '*';
1559 vector<docstring> const keys = getVectorFromString(key);
1561 vector<CitationStyle> const citeStyleList = buf->params().citeStyles();
1562 static const size_t max_length = 40;
1563 vector<docstring> citeStrings =
1564 buf->masterBibInfo().getCiteStrings(keys, citeStyleList, bv->buffer(),
1565 before, after, from_utf8("dialog"), max_length);
1567 vector<docstring>::const_iterator cit = citeStrings.begin();
1568 vector<docstring>::const_iterator end = citeStrings.end();
1570 for (int ii = 1; cit != end; ++cit, ++ii) {
1571 docstring label = *cit;
1572 CitationStyle cs = citeStyleList[ii - 1];
1573 cs.forceUpperCase &= force;
1574 cs.fullAuthorList &= full;
1575 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1576 FuncRequest(LFUN_INSET_MODIFY,
1577 "changetype " + from_utf8(citationStyleToString(cs)))));
1582 void MenuDefinition::expandArguments(BufferView const * bv, bool switcharg)
1587 if (!bv->cursor().inTexted())
1590 Inset const * inset = &bv->cursor().inset();
1591 Layout::LaTeXArgMap args = bv->cursor().paragraph().layout().args();
1592 if (inset && args.empty())
1593 args = inset->getLayout().args();
1594 if (args.empty() || (switcharg && args.size() == 1))
1596 Layout::LaTeXArgMap::const_iterator lait = args.begin();
1597 Layout::LaTeXArgMap::const_iterator const laend = args.end();
1598 for (; lait != laend; ++lait) {
1599 Layout::latexarg arg = (*lait).second;
1600 docstring str = arg.menustring.empty()? arg.labelstring : arg.menustring;
1601 QString item = toqstr(translateIfPossible(str));
1603 add(MenuItem(MenuItem::Command, item,
1604 FuncRequest(LFUN_INSET_MODIFY,
1605 from_ascii("changetype ")
1606 + from_ascii((*lait).first))));
1608 add(MenuItem(MenuItem::Command, item,
1609 FuncRequest(LFUN_ARGUMENT_INSERT,
1610 from_ascii((*lait).first))));
1615 void MenuDefinition::expandCaptions(Buffer const * buf, bool switchcap)
1620 vector<docstring> caps;
1621 DocumentClass const & dc = buf->params().documentClass();
1622 TextClass::InsetLayouts::const_iterator lit = dc.insetLayouts().begin();
1623 TextClass::InsetLayouts::const_iterator len = dc.insetLayouts().end();
1624 for (; lit != len; ++lit) {
1625 if (prefixIs(lit->first, from_ascii("Caption:")))
1626 caps.push_back(lit->first);
1629 if (caps.empty() || (switchcap && caps.size() == 1))
1631 if (caps.size() == 1) {
1633 docstring const type = split(*caps.begin(), dummy, ':');
1634 add(MenuItem(MenuItem::Command, qt_("Caption"),
1635 FuncRequest(LFUN_CAPTION_INSERT, translateIfPossible(type))));
1639 MenuDefinition captions;
1641 vector<docstring>::const_iterator cit = caps.begin();
1642 vector<docstring>::const_iterator end = caps.end();
1644 for (int ii = 1; cit != end; ++cit, ++ii) {
1646 docstring const type = split(*cit, dummy, ':');
1647 docstring const trtype = translateIfPossible(type);
1648 docstring const cmitem = bformat(_("Caption (%1$s)"), trtype);
1649 // make menu item optional, otherwise we would also see
1650 // forbidden caption types
1652 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cmitem),
1653 FuncRequest(LFUN_INSET_MODIFY,
1654 from_ascii("changetype ")
1655 + type), QString(), true));
1657 captions.addWithStatusCheck(MenuItem(MenuItem::Command,
1659 FuncRequest(LFUN_CAPTION_INSERT,
1660 type), QString(), true));
1662 if (!captions.empty()) {
1663 MenuItem item(MenuItem::Submenu, qt_("Caption"));
1664 item.setSubmenu(captions);
1670 void MenuDefinition::expandEnvironmentSeparators(BufferView const * bv)
1674 Text const * text = bv->cursor().text();
1675 // no paragraphs and no separators exist in math
1679 pit_type pit = bv->cursor().selBegin().pit();
1680 Paragraph const & par = text->getPar(pit);
1681 docstring const curlayout = par.layout().name();
1682 docstring outerlayout;
1683 depth_type current_depth = par.params().depth();
1684 // check if we have an environment in our nesting hierarchy
1685 Paragraph cpar = par;
1687 if (pit == 0 || cpar.params().depth() == 0)
1690 cpar = text->getPar(pit);
1691 if (cpar.params().depth() < current_depth
1692 && cpar.layout().isEnvironment()) {
1693 outerlayout = cpar.layout().name();
1694 current_depth = cpar.params().depth();
1697 if (par.layout().isEnvironment()) {
1698 docstring const label =
1699 bformat(_("Start New Environment (%1$s)"),
1700 translateIfPossible(curlayout));
1701 add(MenuItem(MenuItem::Command, toqstr(label),
1702 FuncRequest(LFUN_ENVIRONMENT_SPLIT)));
1704 if (!outerlayout.empty()) {
1705 docstring const label =
1706 bformat(_("Start New Parent Environment (%1$s)"),
1707 translateIfPossible(outerlayout));
1708 add(MenuItem(MenuItem::Command, toqstr(label),
1709 FuncRequest(LFUN_ENVIRONMENT_SPLIT,
1710 from_ascii("outer"))));
1717 /////////////////////////////////////////////////////////////////////
1718 // Menu::Impl definition and implementation
1719 /////////////////////////////////////////////////////////////////////
1723 /// populates the menu or one of its submenu
1724 /// This is used as a recursive function
1725 void populate(QMenu & qMenu, MenuDefinition const & menu);
1727 /// Only needed for top level menus.
1728 MenuDefinition * top_level_menu;
1731 /// the name of this menu
1737 /// Get a MenuDefinition item label from the menu backend
1738 static QString label(MenuItem const & mi)
1740 QString label = mi.label();
1741 label.replace("&", "&&");
1743 QString shortcut = mi.shortcut();
1744 if (!shortcut.isEmpty()) {
1745 int pos = label.indexOf(shortcut);
1747 //label.insert(pos, 1, char_type('&'));
1748 label.replace(pos, 0, "&");
1751 QString const binding = mi.binding();
1752 if (!binding.isEmpty())
1753 label += '\t' + binding;
1758 void Menu::Impl::populate(QMenu & qMenu, MenuDefinition const & menu)
1760 LYXERR(Debug::GUI, "populating menu " << menu.name());
1762 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
1765 LYXERR(Debug::GUI, " ***** menu entries " << menu.size());
1766 MenuDefinition::const_iterator m = menu.begin();
1767 MenuDefinition::const_iterator end = menu.end();
1768 for (; m != end; ++m) {
1769 if (m->kind() == MenuItem::Separator)
1770 qMenu.addSeparator();
1771 else if (m->kind() == MenuItem::Submenu) {
1772 QMenu * subMenu = qMenu.addMenu(label(*m));
1773 populate(*subMenu, m->submenu());
1774 subMenu->setEnabled(!subMenu->isEmpty());
1776 // we have a MenuItem::Command
1777 qMenu.addAction(new Action(QIcon(), label(*m),
1778 m->func(), m->tooltip(), &qMenu));
1783 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
1784 class AlwaysMnemonicStyle : public QProxyStyle {
1786 int styleHint(StyleHint hint, const QStyleOption *opt = 0, const QWidget *widget = 0,
1787 QStyleHintReturn *returnData = 0) const
1789 if (hint == QStyle::SH_UnderlineShortcut)
1791 return QProxyStyle::styleHint(hint, opt, widget, returnData);
1796 /////////////////////////////////////////////////////////////////////
1797 // Menu implementation
1798 /////////////////////////////////////////////////////////////////////
1800 Menu::Menu(GuiView * gv, QString const & name, bool top_level, bool keyboard)
1801 : QMenu(gv), d(new Menu::Impl)
1803 #if (defined(Q_OS_WIN) || defined(Q_CYGWIN_WIN)) && (QT_VERSION >= 0x040600)
1805 setStyle(new AlwaysMnemonicStyle);
1809 d->top_level_menu = top_level? new MenuDefinition : 0;
1813 if (d->top_level_menu)
1814 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1820 delete d->top_level_menu;
1825 void Menu::updateView()
1827 guiApp->menus().updateMenu(this);
1833 QList<QAction *> items = actions();
1834 for (int i = 0; i != items.size(); ++i) {
1835 // QAction::menu() returns 0 if there's no submenu.
1836 delete items.at(i)->menu();
1842 /////////////////////////////////////////////////////////////////////
1843 // Menus::Impl definition and implementation
1844 /////////////////////////////////////////////////////////////////////
1846 struct Menus::Impl {
1848 bool hasMenu(QString const &) const;
1850 MenuDefinition & getMenu(QString const &);
1852 MenuDefinition const & getMenu(QString const &) const;
1854 /// Expands some special entries of the menu
1855 /** The entries with the following kind are expanded to a
1856 sequence of Command MenuItems: Lastfiles, Documents,
1857 ViewFormats, ExportFormats, UpdateFormats, Branches,
1858 Indices, Arguments, SwitchArguments, Captions, SwitchCaptions,
1859 EnvironmentSeparators
1861 void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1862 BufferView const *) const;
1864 /// Initialize specific MACOS X menubar
1865 void macxMenuBarInit(QMenuBar * qmb);
1867 /// Mac special menu.
1868 /** This defines a menu whose entries list the FuncRequests
1869 that will be removed by expand() in other menus. This is
1870 used by the Qt/Mac code.
1872 NOTE: Qt does not remove the menu items when clearing a QMenuBar,
1873 such that the items will keep accessing the FuncRequests in
1874 the MenuDefinition. While Menus::Impl might be recreated,
1875 we keep mac_special_menu_ in memory by making it static.
1877 static MenuDefinition mac_special_menu_;
1882 MenuDefinition menubar_;
1884 typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
1886 /// name to menu for \c menu() method.
1891 MenuDefinition Menus::Impl::mac_special_menu_;
1895 Here is what the Qt documentation says about how a menubar is chosen:
1897 1) If the window has a QMenuBar then it is used. 2) If the window
1898 is a modal then its menubar is used. If no menubar is specified
1899 then a default menubar is used (as documented below) 3) If the
1900 window has no parent then the default menubar is used (as
1903 The above 3 steps are applied all the way up the parent window
1904 chain until one of the above are satisifed. If all else fails a
1905 default menubar will be created, the default menubar on Qt/Mac is
1906 an empty menubar, however you can create a different default
1907 menubar by creating a parentless QMenuBar, the first one created
1908 will thus be designated the default menubar, and will be used
1909 whenever a default menubar is needed.
1911 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1912 that this menubar will be used also when one of LyX' dialogs has
1915 void Menus::Impl::macxMenuBarInit(QMenuBar * qmb)
1917 /* Since Qt 4.2, the qt/mac menu code has special code for
1918 specifying the role of a menu entry. However, it does not
1919 work very well with our scheme of creating menus on demand,
1920 and therefore we need to put these entries in a special
1921 invisible menu. (JMarc)
1924 /* The entries of our special mac menu. If we add support for
1925 * special entries in Menus, we could imagine something
1927 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
1928 * and therefore avoid hardcoding. I am not sure it is worth
1929 * the hassle, though. (JMarc)
1931 struct MacMenuEntry {
1935 QAction::MenuRole role;
1938 static MacMenuEntry entries[] = {
1939 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1940 QAction::AboutRole},
1941 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1942 QAction::PreferencesRole},
1943 #if !(defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
1944 /* This doesn't work with Cocoa. */
1945 {LFUN_RECONFIGURE, "", "Reconfigure",
1946 QAction::ApplicationSpecificRole},
1948 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1950 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1951 const bool first_call = mac_special_menu_.empty();
1953 LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
1954 // the special menu for Menus. Fill it up only once.
1956 for (size_t i = 0 ; i < num_entries ; ++i) {
1957 FuncRequest const func(entries[i].action,
1958 from_utf8(entries[i].arg));
1959 mac_special_menu_.add(MenuItem(MenuItem::Command,
1960 entries[i].label, func));
1964 // add the entries to a QMenu that will eventually be empty
1965 // and therefore invisible.
1966 QMenu * qMenu = qmb->addMenu("special");
1967 MenuDefinition::const_iterator cit = mac_special_menu_.begin();
1968 MenuDefinition::const_iterator end = mac_special_menu_.end();
1969 for (size_t i = 0 ; cit != end ; ++cit, ++i) {
1970 Action * action = new Action(QIcon(), cit->label(),
1971 cit->func(), QString(), qMenu);
1972 action->setMenuRole(entries[i].role);
1973 qMenu->addAction(action);
1978 void Menus::Impl::expand(MenuDefinition const & frommenu,
1979 MenuDefinition & tomenu, BufferView const * bv) const
1981 if (!tomenu.empty())
1984 for (MenuDefinition::const_iterator cit = frommenu.begin();
1985 cit != frommenu.end() ; ++cit) {
1986 Buffer const * buf = bv ? &bv->buffer() : 0;
1987 switch (cit->kind()) {
1988 case MenuItem::Lastfiles:
1989 tomenu.expandLastfiles();
1992 case MenuItem::Documents:
1993 tomenu.expandDocuments();
1996 case MenuItem::Bookmarks:
1997 tomenu.expandBookmarks();
2000 case MenuItem::ImportFormats:
2001 case MenuItem::ViewFormats:
2002 case MenuItem::UpdateFormats:
2003 case MenuItem::ExportFormats:
2004 tomenu.expandFormats(cit->kind(), buf);
2007 case MenuItem::CharStyles:
2008 tomenu.expandFlexInsert(buf, InsetLayout::CHARSTYLE);
2011 case MenuItem::Custom:
2012 tomenu.expandFlexInsert(buf, InsetLayout::CUSTOM);
2015 case MenuItem::Elements:
2016 tomenu.expandFlexInsert(buf, InsetLayout::ELEMENT);
2019 case MenuItem::FloatListInsert:
2020 tomenu.expandFloatListInsert(buf);
2023 case MenuItem::FloatInsert:
2024 tomenu.expandFloatInsert(buf);
2027 case MenuItem::PasteRecent:
2028 tomenu.expandPasteRecent(buf);
2031 case MenuItem::Toolbars:
2032 tomenu.expandToolbars();
2035 case MenuItem::Branches:
2036 tomenu.expandBranches(buf);
2039 case MenuItem::Indices:
2040 tomenu.expandIndices(buf);
2043 case MenuItem::IndicesContext:
2044 tomenu.expandIndicesContext(buf);
2047 case MenuItem::IndicesLists:
2048 tomenu.expandIndices(buf, true);
2051 case MenuItem::IndicesListsContext:
2052 tomenu.expandIndicesContext(buf, true);
2055 case MenuItem::CiteStyles:
2056 tomenu.expandCiteStyles(bv);
2060 tomenu.expandToc(buf);
2063 case MenuItem::GraphicsGroups:
2064 tomenu.expandGraphicsGroups(bv);
2067 case MenuItem::SpellingSuggestions:
2068 tomenu.expandSpellingSuggestions(bv);
2071 case MenuItem::LanguageSelector:
2072 tomenu.expandLanguageSelector(buf);
2075 case MenuItem::Arguments:
2076 tomenu.expandArguments(bv, false);
2079 case MenuItem::SwitchArguments:
2080 tomenu.expandArguments(bv, true);
2083 case MenuItem::Captions:
2084 tomenu.expandCaptions(buf, false);
2087 case MenuItem::SwitchCaptions:
2088 tomenu.expandCaptions(buf, true);
2091 case MenuItem::EnvironmentSeparators:
2092 tomenu.expandEnvironmentSeparators(bv);
2095 case MenuItem::Submenu: {
2096 MenuItem item(*cit);
2097 item.setSubmenu(MenuDefinition(cit->submenuname()));
2098 expand(getMenu(cit->submenuname()), item.submenu(), bv);
2099 tomenu.addWithStatusCheck(item);
2103 case MenuItem::Info:
2104 case MenuItem::Help:
2105 case MenuItem::Separator:
2106 tomenu.addWithStatusCheck(*cit);
2109 case MenuItem::Command:
2110 if (!mac_special_menu_.hasFunc(cit->func()))
2111 tomenu.addWithStatusCheck(*cit);
2115 // we do not want the menu to end with a separator
2116 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
2117 tomenu.items_.pop_back();
2119 // Check whether the shortcuts are unique
2120 tomenu.checkShortcuts();
2124 bool Menus::Impl::hasMenu(QString const & name) const
2126 return find_if(menulist_.begin(), menulist_.end(),
2127 MenuNamesEqual(name)) != menulist_.end();
2131 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
2133 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
2134 MenuNamesEqual(name));
2135 if (cit == menulist_.end()) {
2136 LYXERR0("No submenu named " << name);
2137 LASSERT(false, { static const MenuDefinition m; return m; });
2143 MenuDefinition & Menus::Impl::getMenu(QString const & name)
2145 iterator it = find_if(menulist_.begin(), menulist_.end(),
2146 MenuNamesEqual(name));
2147 if (it == menulist_.end()) {
2148 LYXERR0("No submenu named " << name);
2149 LASSERT(false, { static MenuDefinition m; return m; });
2155 /////////////////////////////////////////////////////////////////////
2159 /////////////////////////////////////////////////////////////////////
2161 Menus::Menus() : d(new Impl) {}
2177 void Menus::read(Lexer & lex)
2185 LexerKeyword menutags[] = {
2186 { "end", md_endmenuset },
2187 { "menu", md_menu },
2188 { "menubar", md_menubar }
2191 // consistency check
2192 if (compare_ascii_no_case(lex.getString(), "menuset"))
2193 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
2195 lex.pushTable(menutags);
2196 lex.setContext("Menus::read");
2200 while (lex.isOK() && !quit) {
2201 switch (lex.lex()) {
2203 d->menubar_.read(lex);
2207 QString const name = toqstr(lex.getDocString());
2208 if (d->hasMenu(name))
2209 d->getMenu(name).read(lex);
2211 MenuDefinition menu(name);
2213 d->menulist_.push_back(menu);
2221 lex.printError("Unknown menu tag");
2229 bool Menus::searchMenu(FuncRequest const & func,
2230 docstring_list & names) const
2232 MenuDefinition menu;
2233 d->expand(d->menubar_, menu, 0);
2234 return menu.searchMenu(func, names);
2238 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
2242 // setup special mac specific menu items, but only do this
2243 // the first time a QMenuBar is created. Otherwise Qt will
2244 // create duplicate items in the application menu. It seems
2245 // that Qt does not remove them when the QMenubar is cleared.
2246 d->macxMenuBarInit(qmb);
2249 // Clear all menubar contents before filling it.
2251 #if (QT_VERSION >= 0x050000 && defined(Q_OS_MAC))
2252 d->macxMenuBarInit(qmb);
2256 LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
2258 if (d->menubar_.empty()) {
2259 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
2260 << d->menubar_.name());
2263 LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
2265 MenuDefinition menu;
2266 BufferView * bv = 0;
2268 bv = view->currentBufferView();
2269 d->expand(d->menubar_, menu, bv);
2271 MenuDefinition::const_iterator m = menu.begin();
2272 MenuDefinition::const_iterator end = menu.end();
2274 for (; m != end; ++m) {
2276 if (m->kind() != MenuItem::Submenu) {
2277 LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
2281 LYXERR(Debug::GUI, "menu bar item " << m->label()
2282 << " is a submenu named " << m->submenuname());
2284 QString name = m->submenuname();
2285 if (!d->hasMenu(name)) {
2286 LYXERR(Debug::GUI, "\tERROR: " << name
2287 << " submenu has no menu!");
2291 Menu * menu = new Menu(view, m->submenuname(), true);
2292 menu->setTitle(label(*m));
2294 #if defined(Q_OS_MAC) && (defined(QT_MAC_USE_COCOA) || (QT_VERSION >= 0x050000))
2295 // On Mac OS with QT/cocoa, the menu is not displayed if there is no action
2296 // so we create a temporary one here
2297 QAction * action = new QAction(menu);
2298 menu->addAction(action);
2303 d->name_map_[view][name] = menu;
2308 void Menus::updateMenu(Menu * qmenu)
2310 LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
2313 if (qmenu->d->name.isEmpty())
2316 docstring identifier = qstring_to_ucs4(qmenu->d->name);
2317 MenuDefinition fromLyxMenu(qmenu->d->name);
2318 while (!identifier.empty()) {
2319 docstring menu_name;
2320 identifier = split(identifier, menu_name, ';');
2322 if (!d->hasMenu(toqstr(menu_name))) {
2323 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
2328 MenuDefinition cat_menu = d->getMenu(toqstr(menu_name));
2329 //FIXME: 50 is a wild guess. We should take into account here
2330 //the expansion of menu items, disabled optional items etc.
2331 bool const in_sub_menu = !fromLyxMenu.empty()
2332 && fromLyxMenu.size() + cat_menu.size() > 50 ;
2334 fromLyxMenu.catSub(menu_name);
2336 fromLyxMenu.cat(cat_menu);
2337 fromLyxMenu.add(MenuItem(MenuItem::Separator));
2340 if (fromLyxMenu.empty()) {
2341 qmenu->addAction(qt_("No Action Defined!"));
2345 BufferView * bv = 0;
2347 bv = qmenu->d->view->currentBufferView();
2348 d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
2349 qmenu->d->populate(*qmenu, *qmenu->d->top_level_menu);
2353 Menu * Menus::menu(QString const & name, GuiView & view, bool keyboard)
2355 LYXERR(Debug::GUI, "Context menu requested: " << name);
2356 Menu * menu = d->name_map_[&view].value(name, 0);
2357 if (!menu && !name.startsWith("context-")) {
2358 LYXERR0("requested context menu not found: " << name);
2362 menu = new Menu(&view, name, true, keyboard);
2363 d->name_map_[&view][name] = menu;
2367 } // namespace frontend
2370 #include "moc_Menus.cpp"