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 "ParIterator.h"
52 #include "SpellChecker.h"
53 #include "TextClass.h"
54 #include "TocBackend.h"
56 #include "WordLangTuple.h"
58 #include "insets/Inset.h"
59 #include "insets/InsetCitation.h"
60 #include "insets/InsetGraphics.h"
62 #include "support/lassert.h"
63 #include "support/convert.h"
64 #include "support/debug.h"
65 #include "support/docstring_list.h"
66 #include "support/filetools.h"
67 #include "support/gettext.h"
68 #include "support/lstrings.h"
75 #if QT_VERSION >= 0x040600
76 #include <QProxyStyle>
79 #include "support/shared_ptr.h"
85 using namespace lyx::support;
93 // MacOSX specific stuff is at the end.
100 /// The type of elements that can be in a menu
108 /** This type of item explains why something is unavailable. If this
109 menuitem is in a submenu, the submenu is enabled to make sure the
110 user sees the information. */
112 /** This type of item merely shows that there might be a list or
113 something alike at this position, but the list is still empty.
114 If this item is in a submenu, the submenu will not always be
117 /** This is the list of last opened file,
118 typically for the File menu. */
120 /** This is the list of opened Documents,
121 typically for the Documents menu. */
123 /** This is the bookmarks */
127 /** This is a list of viewable formats
128 typically for the File->View menu. */
130 /** This is a list of updatable formats
131 typically for the File->Update menu. */
133 /** This is a list of exportable formats
134 typically for the File->Export menu. */
136 /** This is a list of importable formats
137 typically for the File->Import menu. */
139 /** This is the list of elements available
140 * for insertion into document. */
142 /** This is the list of user-configurable
143 insets to insert into document */
145 /** This is the list of XML elements to
146 insert into the document */
148 /** This is the list of floats that we can
149 insert a list for. */
151 /** This is the list of floats that we can
154 /** This is the list of selections that can
159 /** Available branches in document */
161 /** Available indices in document */
163 /** Context menu for indices in document */
165 /** Available index lists in document */
167 /** Context menu for available indices lists in document */
169 /** Available citation styles for a given citation */
171 /** Available graphics groups */
173 /// Words suggested by the spellchecker.
175 /** Used Languages */
177 /** This is the list of arguments available
178 for insertion into the current layout. */
180 /** This is the list of arguments available
181 in the InsetArgument context menu. */
183 /** This is the list of captions available
184 in the current layout. */
186 /** This is the list of captions available
187 in the InsetCaption context menu. */
191 explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
194 QString const & label,
195 QString const & submenu = QString(),
196 QString const & tooltip = QString(),
197 bool optional = false)
198 : kind_(kind), label_(label), submenuname_(submenu),
199 tooltip_(tooltip), optional_(optional)
201 LATTEST(kind == Submenu || kind == Help || kind == Info);
205 QString const & label,
206 FuncRequest const & func,
207 QString const & tooltip = QString(),
208 bool optional = false,
209 FuncRequest::Origin origin = FuncRequest::MENU)
210 : kind_(kind), label_(label), func_(func),
211 tooltip_(tooltip), optional_(optional)
213 func_.setOrigin(origin);
216 // shared_ptr<MenuDefinition> needs this apprently...
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 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);
290 QString submenuname_;
297 /// contains 0 or 1 item.
298 QList<MenuDefinition> submenu_;
302 class MenuDefinition {
305 typedef std::vector<MenuItem> ItemList;
307 typedef ItemList::const_iterator const_iterator;
309 explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
314 QString const & name() const { return name_; }
316 bool empty() const { return items_.empty(); }
317 /// Clear the menu content.
318 void clear() { items_.clear(); }
320 size_t size() const { return items_.size(); }
322 MenuItem const & operator[](size_t) const;
324 const_iterator begin() const { return items_.begin(); }
326 const_iterator end() const { return items_.end(); }
328 void cat(MenuDefinition const & other);
330 void catSub(docstring const & name);
332 // search for func in this menu iteratively, and put menu
334 bool searchMenu(FuncRequest const & func, docstring_list & names)
337 bool hasFunc(FuncRequest const &) const;
338 /// Add the menu item unconditionally
339 void add(MenuItem const & item) { items_.push_back(item); }
340 /// Checks the associated FuncRequest status before adding the
342 void addWithStatusCheck(MenuItem const &);
343 // Check whether the menu shortcuts are unique
344 void checkShortcuts() const;
346 void expandLastfiles();
347 void expandDocuments();
348 void expandBookmarks();
349 void expandFormats(MenuItem::Kind const kind, Buffer const * buf);
350 void expandFloatListInsert(Buffer const * buf);
351 void expandFloatInsert(Buffer const * buf);
352 void expandFlexInsert(Buffer const * buf, InsetLayout::InsetLyXType type);
353 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth);
354 void expandToc(Buffer const * buf);
355 void expandPasteRecent(Buffer const * buf);
356 void expandToolbars();
357 void expandBranches(Buffer const * buf);
358 void expandIndices(Buffer const * buf, bool listof = false);
359 void expandIndicesContext(Buffer const * buf, bool listof = false);
360 void expandCiteStyles(BufferView const *);
361 void expandGraphicsGroups(BufferView const *);
362 void expandSpellingSuggestions(BufferView const *);
363 void expandLanguageSelector(Buffer const * buf);
364 void expandArguments(BufferView const *, bool switcharg = false);
365 void expandCaptions(Buffer const * buf, bool switchcap = false);
373 /// Helper for std::find_if
377 MenuNamesEqual(QString const & name) : name_(name) {}
378 bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
385 typedef std::vector<MenuDefinition> MenuList;
387 typedef MenuList::const_iterator const_iterator;
389 typedef MenuList::iterator iterator;
391 /////////////////////////////////////////////////////////////////////
392 // MenuDefinition implementation
393 /////////////////////////////////////////////////////////////////////
395 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
399 case MenuItem::Command: {
400 FuncStatus status = lyx::getStatus(i.func());
401 if (status.unknown() || (!status.enabled() && i.optional()))
404 items_.back().status(status);
408 case MenuItem::Submenu: {
409 bool enabled = false;
410 if (i.hasSubmenu()) {
411 for (const_iterator cit = i.submenu().begin();
412 cit != i.submenu().end(); ++cit) {
413 // Only these kind of items affect the status of the submenu
414 if ((cit->kind() == MenuItem::Command
415 || cit->kind() == MenuItem::Submenu
416 || cit->kind() == MenuItem::Help)
417 && cit->status().enabled()) {
423 if (enabled || !i.optional()) {
425 items_.back().status().setEnabled(enabled);
430 case MenuItem::Separator:
431 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
441 void MenuDefinition::read(Lexer & lex)
458 md_indiceslistscontext,
472 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 { "exportformats", md_exportformats },
492 { "floatinsert", md_floatinsert },
493 { "floatlistinsert", md_floatlistinsert },
494 { "graphicsgroups", md_graphicsgroups },
495 { "importformats", md_importformats },
496 { "indices", md_indices },
497 { "indicescontext", md_indicescontext },
498 { "indiceslists", md_indiceslists },
499 { "indiceslistscontext", md_indiceslistscontext },
501 { "languageselector", md_languageselector },
502 { "lastfiles", md_lastfiles },
503 { "optitem", md_optitem },
504 { "optsubmenu", md_optsubmenu },
505 { "pasterecent", md_pasterecent },
506 { "separator", md_separator },
507 { "spellingsuggestions", md_spellingsuggestions },
508 { "submenu", md_submenu },
509 { "switcharguments", md_switcharguments },
510 { "switchcaptions", md_switchcaptions },
512 { "toolbars", md_toolbars },
513 { "updateformats", md_updateformats },
514 { "viewformats", md_viewformats }
517 lex.pushTable(menutags);
518 lex.setContext("MenuDefinition::read: ");
521 while (lex.isOK() && md_type != md_endmenu) {
522 switch (md_type = lex.lex()) {
526 docstring const name = translateIfPossible(lex.getDocString());
528 string const command = lex.getString();
529 FuncRequest func = lyxaction.lookupFunc(command);
530 FuncRequest::Origin origin = FuncRequest::MENU;
531 if (name_.startsWith("context-toc-"))
532 origin = FuncRequest::TOC;
533 bool const optional = (md_type == md_optitem);
534 add(MenuItem(MenuItem::Command, toqstr(name), func, QString(), optional, origin));
539 add(MenuItem(MenuItem::Separator));
543 add(MenuItem(MenuItem::Lastfiles));
547 add(MenuItem(MenuItem::CharStyles));
551 add(MenuItem(MenuItem::Custom));
555 add(MenuItem(MenuItem::Elements));
559 add(MenuItem(MenuItem::Documents));
563 add(MenuItem(MenuItem::Bookmarks));
567 add(MenuItem(MenuItem::Toc));
571 add(MenuItem(MenuItem::ViewFormats));
574 case md_updateformats:
575 add(MenuItem(MenuItem::UpdateFormats));
578 case md_exportformats:
579 add(MenuItem(MenuItem::ExportFormats));
582 case md_importformats:
583 add(MenuItem(MenuItem::ImportFormats));
586 case md_floatlistinsert:
587 add(MenuItem(MenuItem::FloatListInsert));
591 add(MenuItem(MenuItem::FloatInsert));
595 add(MenuItem(MenuItem::PasteRecent));
599 add(MenuItem(MenuItem::Toolbars));
603 add(MenuItem(MenuItem::Branches));
607 add(MenuItem(MenuItem::CiteStyles));
610 case md_graphicsgroups:
611 add(MenuItem(MenuItem::GraphicsGroups));
614 case md_spellingsuggestions:
615 add(MenuItem(MenuItem::SpellingSuggestions));
618 case md_languageselector:
619 add(MenuItem(MenuItem::LanguageSelector));
623 add(MenuItem(MenuItem::Indices));
626 case md_indicescontext:
627 add(MenuItem(MenuItem::IndicesContext));
630 case md_indiceslists:
631 add(MenuItem(MenuItem::IndicesLists));
634 case md_indiceslistscontext:
635 add(MenuItem(MenuItem::IndicesListsContext));
639 add(MenuItem(MenuItem::Arguments));
642 case md_switcharguments:
643 add(MenuItem(MenuItem::SwitchArguments));
647 add(MenuItem(MenuItem::Captions));
650 case md_switchcaptions:
651 add(MenuItem(MenuItem::SwitchCaptions));
657 docstring const mlabel = translateIfPossible(lex.getDocString());
659 docstring const mname = lex.getDocString();
660 bool const optional = (md_type == md_optsubmenu);
661 add(MenuItem(MenuItem::Submenu,
662 toqstr(mlabel), toqstr(mname), QString(), optional));
670 lex.printError("Unknown menu tag");
678 MenuItem const & MenuDefinition::operator[](size_type i) const
684 bool MenuDefinition::hasFunc(FuncRequest const & func) const
686 for (const_iterator it = begin(), et = end(); it != et; ++it)
687 if (it->func() == func)
693 void MenuDefinition::catSub(docstring const & name)
695 add(MenuItem(MenuItem::Submenu,
696 qt_("More...|M"), toqstr(name), QString(), false));
699 void MenuDefinition::cat(MenuDefinition const & other)
701 const_iterator et = other.end();
702 for (const_iterator it = other.begin(); it != et; ++it)
707 void MenuDefinition::checkShortcuts() const
709 // This is a quadratic algorithm, but we do not care because
710 // menus are short enough
711 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
712 QString shortcut = it1->shortcut();
713 if (shortcut.isEmpty())
715 if (!it1->label().contains(shortcut))
716 LYXERR0("Menu warning: menu entry \""
718 << "\" does not contain shortcut `"
719 << shortcut << "'.");
720 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
721 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
722 LYXERR0("Menu warning: menu entries "
723 << '"' << it1->fulllabel()
724 << "\" and \"" << it2->fulllabel()
725 << "\" share the same shortcut.");
732 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
734 const_iterator m = begin();
735 const_iterator m_end = end();
736 for (; m != m_end; ++m) {
737 if (m->kind() == MenuItem::Command && m->func() == func) {
738 names.push_back(qstring_to_ucs4(m->label()));
741 if (m->kind() == MenuItem::Submenu) {
742 names.push_back(qstring_to_ucs4(m->label()));
743 if (!m->hasSubmenu()) {
744 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
745 << m->label() << " name=" << m->submenuname());
749 if (m->submenu().searchMenu(func, names))
758 QString limitStringLength(docstring const & str)
760 size_t const max_item_length = 45;
762 if (str.size() > max_item_length)
763 return toqstr(str.substr(0, max_item_length - 3) + "...");
769 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
774 graphics::getGraphicsGroups(bv->buffer(), grp);
778 set<string>::const_iterator it = grp.begin();
779 set<string>::const_iterator end = grp.end();
780 add(MenuItem(MenuItem::Command, qt_("No Group"),
781 FuncRequest(LFUN_SET_GRAPHICS_GROUP)));
782 for (; it != end; ++it) {
783 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it) + '|',
784 FuncRequest(LFUN_SET_GRAPHICS_GROUP, *it)));
789 void MenuDefinition::expandSpellingSuggestions(BufferView const * bv)
793 Cursor const & cur = bv->cursor();
797 docstring_list suggestions;
798 Paragraph const & par = cur.paragraph();
799 pos_type from = cur.pos();
801 SpellChecker::Result res = par.spellCheck(from, to, wl, suggestions, true, true);
803 case SpellChecker::UNKNOWN_WORD:
804 if (lyxrc.spellcheck_continuously) {
805 LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
806 docstring const & selection = cur.selectionAsString(false);
807 if (!cur.selection() || selection == wl.word()) {
809 size_t m = 10; // first submenu index
810 MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
811 item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
812 for (; i != suggestions.size(); ++i) {
813 docstring const & suggestion = suggestions[i];
814 LYXERR(Debug::GUI, suggestion);
815 MenuItem w(MenuItem::Command, toqstr(suggestion),
816 FuncRequest(LFUN_WORD_REPLACE,
817 replace2string(suggestion, selection,
818 true, // case sensitive
822 false))); // find next
826 item.submenu().add(w);
831 add(MenuItem(MenuItem::Separator));
832 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
833 add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|n"),
834 FuncRequest(LFUN_SPELLING_ADD, arg)));
835 add(MenuItem(MenuItem::Command, qt_("Ignore all|I"),
836 FuncRequest(LFUN_SPELLING_IGNORE, arg)));
840 case SpellChecker::LEARNED_WORD: {
841 LYXERR(Debug::GUI, "Learned Word.");
842 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
843 add(MenuItem(MenuItem::Command, qt_("Remove from personal dictionary|r"),
844 FuncRequest(LFUN_SPELLING_REMOVE, arg)));
847 case SpellChecker::NO_DICTIONARY:
848 LYXERR(Debug::GUI, "No dictionary for language " + from_ascii(wl.lang()->lang()));
850 case SpellChecker::WORD_OK:
851 case SpellChecker::COMPOUND_WORD:
852 case SpellChecker::ROOT_FOUND:
853 case SpellChecker::IGNORED_WORD:
858 struct sortLanguageByName {
859 bool operator()(const Language * a, const Language * b) const {
860 return qt_(a->display()).localeAwareCompare(qt_(b->display())) < 0;
864 void MenuDefinition::expandLanguageSelector(Buffer const * buf)
869 std::set<Language const *> languages_buffer =
870 buf->masterBuffer()->getLanguages();
872 if (languages_buffer.size() < 2)
875 std::set<Language const *, sortLanguageByName> languages;
877 std::set<Language const *>::const_iterator const beg =
878 languages_buffer.begin();
879 for (std::set<Language const *>::const_iterator cit = beg;
880 cit != languages_buffer.end(); ++cit) {
881 languages.insert(*cit);
884 MenuItem item(MenuItem::Submenu, qt_("Language|L"));
885 item.setSubmenu(MenuDefinition(qt_("Language")));
886 QString morelangs = qt_("More Languages ...|M");
887 QStringList accelerators;
888 if (morelangs.contains('|'))
889 accelerators.append(morelangs.section('|', -1));
890 std::set<Language const *, sortLanguageByName>::const_iterator const begin = languages.begin();
891 for (std::set<Language const *, sortLanguageByName>::const_iterator cit = begin;
892 cit != languages.end(); ++cit) {
893 QString label = qt_((*cit)->display());
894 // try to add an accelerator
895 bool success = false;
896 // try capitals first
897 for (int i = 0; i < label.size(); ++i) {
898 QChar const ch = label[i];
901 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
902 label = label + toqstr("|") + ch;
903 accelerators.append(ch);
908 // if all capitals are taken, try the rest
910 for (int i = 0; i < label.size(); ++i) {
911 if (label[i].isSpace())
913 QString const ch = QString(label[i]);
914 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
915 label = label + toqstr("|") + ch;
916 accelerators.append(ch);
921 MenuItem w(MenuItem::Command, label,
922 FuncRequest(LFUN_LANGUAGE, (*cit)->lang() + " set"));
923 item.submenu().addWithStatusCheck(w);
925 item.submenu().add(MenuItem(MenuItem::Separator));
926 item.submenu().add(MenuItem(MenuItem::Command, morelangs,
927 FuncRequest(LFUN_DIALOG_SHOW, "character")));
932 void MenuDefinition::expandLastfiles()
934 LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
935 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
939 for (; lfit != lf.end() && ii <= lyxrc.num_lastfiles; ++lfit, ++ii) {
940 string const file = lfit->absFileName();
941 QString const short_path = toqstr(makeDisplayPath(file, 30));
942 QString const long_path = toqstr(makeDisplayPath(file));
945 label = QString("%1. %2|%3").arg(ii).arg(short_path).arg(ii);
947 label = QString("%1. %2").arg(ii).arg(short_path);
948 add(MenuItem(MenuItem::Command, label,
949 FuncRequest(LFUN_FILE_OPEN, file), long_path));
954 void MenuDefinition::expandDocuments()
956 MenuItem item(MenuItem::Submenu, qt_("Hidden|H"));
957 item.setSubmenu(MenuDefinition(qt_("Hidden|H")));
959 Buffer * first = theBufferList().first();
961 add(MenuItem(MenuItem::Info, qt_("<No Documents Open>")));
967 if (!guiApp->currentView())
969 GuiWorkArea * wa = guiApp->currentView()->workArea(i);
972 Buffer const & b = wa->bufferView().buffer();
973 QString label = toqstr(b.fileName().displayName(20));
977 label = QString::number(i) + ". " + label + '|' + QString::number(i);
978 add(MenuItem(MenuItem::Command, label,
979 FuncRequest(LFUN_BUFFER_SWITCH, b.absFileName())));
986 // We cannot use a for loop as the buffer list cycles.
988 if (!(guiApp->currentView()
989 && guiApp->currentView()->workArea(*b))) {
990 QString label = toqstr(b->fileName().displayName(20));
994 label = QString::number(i) + ". " + label + '|' + QString::number(i);
995 item.submenu().add(MenuItem(MenuItem::Command, label,
996 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
999 b = theBufferList().next(b);
1000 } while (b != first);
1002 if (!item.submenu().empty())
1007 void MenuDefinition::expandBookmarks()
1009 lyx::BookmarksSection const & bm = theSession().bookmarks();
1012 for (size_t i = 1; i <= bm.size(); ++i) {
1013 if (bm.isValid(i)) {
1014 string const file = bm.bookmark(i).filename.absFileName();
1015 QString const label = QString("%1. %2|%3").arg(i)
1016 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
1017 add(MenuItem(MenuItem::Command, label,
1018 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
1023 add(MenuItem(MenuItem::Info, qt_("<No Bookmarks Saved Yet>")));
1027 void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf)
1029 if (!buf && kind != MenuItem::ImportFormats)
1032 typedef vector<Format const *> Formats;
1034 FuncCode action = LFUN_NOACTION;
1037 case MenuItem::ImportFormats:
1038 formats = theConverters().importableFormats();
1039 action = LFUN_BUFFER_IMPORT;
1041 case MenuItem::ViewFormats:
1042 formats = buf->params().exportableFormats(true);
1043 action = LFUN_BUFFER_VIEW;
1045 case MenuItem::UpdateFormats:
1046 formats = buf->params().exportableFormats(true);
1047 action = LFUN_BUFFER_UPDATE;
1049 case MenuItem::ExportFormats:
1050 formats = buf->params().exportableFormats(false);
1051 action = LFUN_BUFFER_EXPORT;
1057 sort(formats.begin(), formats.end(), Format::formatSorter);
1059 bool const view_update = (kind == MenuItem::ViewFormats
1060 || kind == MenuItem::UpdateFormats);
1064 smenue = (kind == MenuItem::ViewFormats
1065 ? qt_("View (Other Formats)|F")
1066 : qt_("Update (Other Formats)|p"));
1067 MenuItem item(MenuItem::Submenu, smenue);
1068 item.setSubmenu(MenuDefinition(smenue));
1070 Formats::const_iterator fit = formats.begin();
1071 Formats::const_iterator end = formats.end();
1072 for (; fit != end ; ++fit) {
1073 if ((*fit)->dummy())
1076 docstring lab = from_utf8((*fit)->prettyname());
1077 docstring const scut = from_utf8((*fit)->shortcut());
1078 docstring const tmplab = lab;
1081 lab += char_type('|') + scut;
1082 docstring const lab_i18n = translateIfPossible(lab);
1083 docstring const shortcut = split(lab_i18n, lab, '|');
1085 bool const untranslated = (lab == lab_i18n);
1086 docstring label = untranslated ? translateIfPossible(tmplab) : lab;
1089 case MenuItem::ImportFormats:
1090 label += from_ascii("...");
1092 case MenuItem::ViewFormats:
1093 case MenuItem::UpdateFormats:
1094 if ((*fit)->name() == buf->params().getDefaultOutputFormat()) {
1095 docstring lbl = (kind == MenuItem::ViewFormats
1096 ? bformat(_("View [%1$s]|V"), label)
1097 : bformat(_("Update [%1$s]|U"), label));
1098 add(MenuItem(MenuItem::Command, toqstr(lbl), FuncRequest(action)));
1102 case MenuItem::ExportFormats:
1103 if (!(*fit)->inExportMenu())
1107 // we already asserted earlier in this case
1111 if (!shortcut.empty())
1112 label += '|' + shortcut;
1116 item.submenu().addWithStatusCheck(MenuItem(MenuItem::Command,
1117 toqstr(label), FuncRequest(action, (*fit)->name())));
1119 item.submenu().add(MenuItem(MenuItem::Command, toqstr(label),
1120 FuncRequest(action, (*fit)->name())));
1123 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1124 FuncRequest(action, (*fit)->name())));
1126 add(MenuItem(MenuItem::Command, toqstr(label),
1127 FuncRequest(action, (*fit)->name())));
1135 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
1140 FloatList const & floats = buf->params().documentClass().floats();
1141 FloatList::const_iterator cit = floats.begin();
1142 FloatList::const_iterator end = floats.end();
1144 for (; cit != end; ++cit) {
1145 if (!cit->second.usesFloatPkg()) {
1146 // Different floats could declare the same ListCommand. We only
1147 // want it on the list once, though.
1148 string const & list_cmd = cit->second.listCommand();
1149 if (list_cmd.empty())
1150 // we do not know how to generate such a list
1152 // This form of insert returns an iterator pointing to the newly
1153 // inserted element OR the existing element with that value, and
1154 // a bool indicating whether we inserted a new element. So we can
1155 // see if one is there and insert it if not all at once.
1156 pair<set<string>::iterator, bool> ret = seen.insert(list_cmd);
1160 string const & list_name = cit->second.listName();
1161 addWithStatusCheck(MenuItem(MenuItem::Command, qt_(list_name),
1162 FuncRequest(LFUN_FLOAT_LIST_INSERT, cit->second.floattype())));
1167 void MenuDefinition::expandFloatInsert(Buffer const * buf)
1172 FloatList const & floats = buf->params().documentClass().floats();
1173 FloatList::const_iterator cit = floats.begin();
1174 FloatList::const_iterator end = floats.end();
1175 for (; cit != end; ++cit) {
1177 QString const label = qt_(cit->second.name());
1178 addWithStatusCheck(MenuItem(MenuItem::Command, label,
1179 FuncRequest(LFUN_FLOAT_INSERT,
1180 cit->second.floattype())));
1185 void MenuDefinition::expandFlexInsert(
1186 Buffer const * buf, InsetLayout::InsetLyXType type)
1191 TextClass::InsetLayouts const & insetLayouts =
1192 buf->params().documentClass().insetLayouts();
1193 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
1194 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
1195 for (; cit != end; ++cit) {
1196 if (cit->second.lyxtype() == type) {
1197 docstring label = cit->first;
1198 // we remove the "Flex:" prefix, if it is present
1199 if (prefixIs(label, from_utf8("Flex:")))
1200 label = label.substr(5);
1201 addWithStatusCheck(MenuItem(MenuItem::Command,
1202 toqstr(translateIfPossible(label)),
1203 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(label))));
1206 // FIXME This is a little clunky.
1207 if (items_.empty() && type == InsetLayout::CUSTOM)
1208 add(MenuItem(MenuItem::Help, qt_("No Custom Insets Defined!")));
1212 size_t const max_number_of_items = 25;
1214 void MenuDefinition::expandToc2(Toc const & toc_list,
1215 size_t from, size_t to, int depth)
1217 int shortcut_count = 0;
1219 // check whether depth is smaller than the smallest depth in toc.
1220 int min_depth = 1000;
1221 for (size_t i = from; i < to; ++i)
1222 min_depth = min(min_depth, toc_list[i].depth());
1223 if (min_depth > depth)
1226 if (to - from <= max_number_of_items) {
1227 for (size_t i = from; i < to; ++i) {
1228 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
1229 label += limitStringLength(toc_list[i].str());
1230 if (toc_list[i].depth() == depth) {
1232 if (shortcut_count < 9) {
1233 if (label.contains(QString::number(shortcut_count + 1)))
1234 label += QString::number(++shortcut_count);
1237 add(MenuItem(MenuItem::Command, label,
1238 FuncRequest(toc_list[i].action())));
1243 size_t new_pos = pos + 1;
1244 while (new_pos < to && toc_list[new_pos].depth() > depth)
1247 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
1248 label += limitStringLength(toc_list[pos].str());
1249 if (toc_list[pos].depth() == depth) {
1251 if (shortcut_count < 9) {
1252 if (label.contains(QString::number(shortcut_count + 1)))
1253 label += QString::number(++shortcut_count);
1256 if (new_pos == pos + 1) {
1257 add(MenuItem(MenuItem::Command,
1258 label, FuncRequest(toc_list[pos].action())));
1261 sub.expandToc2(toc_list, pos, new_pos, depth + 1);
1262 MenuItem item(MenuItem::Submenu, label);
1263 item.setSubmenu(sub);
1272 void MenuDefinition::expandToc(Buffer const * buf)
1274 // To make things very cleanly, we would have to pass buf to
1275 // all MenuItem constructors and to expandToc2. However, we
1276 // know that all the entries in a TOC will be have status_ ==
1277 // OK, so we avoid this unnecessary overhead (JMarc)
1280 add(MenuItem(MenuItem::Info, qt_("<No Document Open>")));
1284 // Add an entry for the master doc if this is a child doc
1285 Buffer const * const master = buf->masterBuffer();
1286 if (buf != master) {
1287 ParIterator const pit = par_iterator_begin(master->inset());
1288 string const arg = convert<string>(pit->id());
1289 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
1290 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
1293 MenuDefinition other_lists;
1295 FloatList const & floatlist = buf->params().documentClass().floats();
1296 TocList const & toc_list = buf->tocBackend().tocs();
1297 TocList::const_iterator cit = toc_list.begin();
1298 TocList::const_iterator end = toc_list.end();
1299 for (; cit != end; ++cit) {
1300 // Handle this later
1301 if (cit->first == "tableofcontents")
1304 MenuDefinition submenu;
1305 if (cit->second.size() >= 30) {
1306 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
1307 submenu.add(MenuItem(MenuItem::Command, qt_("Open Navigator..."), f));
1309 TocIterator ccit = cit->second.begin();
1310 TocIterator eend = cit->second.end();
1311 for (; ccit != eend; ++ccit) {
1312 submenu.add(MenuItem(MenuItem::Command,
1313 limitStringLength(ccit->str()) + '|',
1314 FuncRequest(ccit->action())));
1318 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
1319 item.setSubmenu(submenu);
1320 if (floatlist.typeExist(cit->first) || cit->first == "child") {
1321 // Those two types deserve to be in the main menu.
1322 item.setSubmenu(submenu);
1325 other_lists.add(item);
1327 if (!other_lists.empty()) {
1328 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
1329 item.setSubmenu(other_lists);
1333 // Handle normal TOC
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);
1341 add(MenuItem(MenuItem::Info, qt_("<Empty Table of Contents>")));
1346 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1348 docstring_list const sel = cap::availableSelections(buf);
1350 docstring_list::const_iterator cit = sel.begin();
1351 docstring_list::const_iterator end = sel.end();
1353 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1354 add(MenuItem(MenuItem::Command, toqstr(*cit) + '|',
1355 FuncRequest(LFUN_PASTE, convert<string>(index))));
1360 void MenuDefinition::expandToolbars()
1362 MenuDefinition other_lists;
1363 // extracts the toolbars from the backend
1364 Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1365 Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1366 for (; cit != end; ++cit) {
1367 MenuItem const item(MenuItem::Command, toqstr(cit->gui_name),
1368 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1369 if (guiApp->toolbars().isMainToolbar(cit->name))
1372 other_lists.add(item);
1375 if (!other_lists.empty()) {
1376 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1377 item.setSubmenu(other_lists);
1383 void MenuDefinition::expandBranches(Buffer const * buf)
1388 BufferParams const & master_params = buf->masterBuffer()->params();
1389 BufferParams const & params = buf->params();
1390 if (params.branchlist().empty() && master_params.branchlist().empty() ) {
1391 add(MenuItem(MenuItem::Help, qt_("No Branches Set for Document!")));
1395 BranchList::const_iterator cit = master_params.branchlist().begin();
1396 BranchList::const_iterator end = master_params.branchlist().end();
1398 for (int ii = 1; cit != end; ++cit, ++ii) {
1399 docstring label = cit->branch();
1401 label = convert<docstring>(ii) + ". " + label
1402 + char_type('|') + convert<docstring>(ii);
1404 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1405 FuncRequest(LFUN_BRANCH_INSERT,
1409 if (buf == buf->masterBuffer())
1412 MenuDefinition child_branches;
1414 BranchList::const_iterator ccit = params.branchlist().begin();
1415 BranchList::const_iterator cend = params.branchlist().end();
1417 for (int ii = 1; ccit != cend; ++ccit, ++ii) {
1418 docstring label = ccit->branch();
1420 label = convert<docstring>(ii) + ". " + label
1421 + char_type('|') + convert<docstring>(ii);
1423 label += char_type('|');
1424 child_branches.addWithStatusCheck(MenuItem(MenuItem::Command,
1426 FuncRequest(LFUN_BRANCH_INSERT,
1430 if (!child_branches.empty()) {
1431 MenuItem item(MenuItem::Submenu, qt_("Child Document"));
1432 item.setSubmenu(child_branches);
1438 void MenuDefinition::expandIndices(Buffer const * buf, bool listof)
1443 BufferParams const & params = buf->masterBuffer()->params();
1444 if (!params.use_indices) {
1446 addWithStatusCheck(MenuItem(MenuItem::Command,
1447 qt_("Index List|I"),
1448 FuncRequest(LFUN_INDEX_PRINT,
1449 from_ascii("idx"))));
1451 addWithStatusCheck(MenuItem(MenuItem::Command,
1452 qt_("Index Entry|d"),
1453 FuncRequest(LFUN_INDEX_INSERT,
1454 from_ascii("idx"))));
1458 if (params.indiceslist().empty())
1461 IndicesList::const_iterator cit = params.indiceslist().begin();
1462 IndicesList::const_iterator end = params.indiceslist().end();
1464 for (int ii = 1; cit != end; ++cit, ++ii) {
1466 docstring const label =
1467 bformat(_("Index: %1$s"), cit->index());
1468 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1469 FuncRequest(LFUN_INDEX_PRINT, cit->shortcut())));
1471 docstring const label =
1472 bformat(_("Index Entry (%1$s)"), cit->index());
1473 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1474 FuncRequest(LFUN_INDEX_INSERT, cit->shortcut())));
1480 void MenuDefinition::expandIndicesContext(Buffer const * buf, bool listof)
1485 BufferParams const & params = buf->masterBuffer()->params();
1486 if (!params.use_indices || params.indiceslist().empty())
1489 IndicesList::const_iterator cit = params.indiceslist().begin();
1490 IndicesList::const_iterator end = params.indiceslist().end();
1492 for (int ii = 1; cit != end; ++cit, ++ii) {
1494 InsetCommandParams p(INDEX_PRINT_CODE);
1495 p["type"] = cit->shortcut();
1496 string const data = InsetCommand::params2string(p);
1497 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
1498 FuncRequest(LFUN_INSET_MODIFY, data)));
1500 docstring const label =
1501 bformat(_("Index Entry (%1$s)"), cit->index());
1502 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1503 FuncRequest(LFUN_INSET_MODIFY,
1504 from_ascii("changetype ") + cit->shortcut())));
1510 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1515 Inset const * inset = bv->cursor().nextInset();
1516 if (!inset || inset->lyxCode() != CITE_CODE) {
1517 add(MenuItem(MenuItem::Command,
1518 qt_("No Citation in Scope!"),
1519 FuncRequest(LFUN_NOACTION)));
1522 InsetCommand const * citinset =
1523 static_cast<InsetCommand const *>(inset);
1525 Buffer const * buf = &bv->buffer();
1526 string const cmd = citinset->params().getCmdName();
1528 docstring const & key = citinset->getParam("key");
1530 add(MenuItem(MenuItem::Command,
1531 qt_("No citations selected!"),
1532 FuncRequest(LFUN_NOACTION)));
1536 docstring const & before = citinset->getParam("before");
1537 docstring const & after = citinset->getParam("after");
1539 size_t const n = cmd.size();
1540 bool const force = cmd[0] == 'C';
1541 bool const full = cmd[n] == '*';
1543 vector<docstring> const keys = getVectorFromString(key);
1545 vector<CitationStyle> const citeStyleList = buf->params().citeStyles();
1546 vector<docstring> citeStrings =
1547 buf->masterBibInfo().getCiteStrings(keys, citeStyleList, bv->buffer(),
1548 false, before, after, from_utf8("dialog"));
1550 vector<docstring>::const_iterator cit = citeStrings.begin();
1551 vector<docstring>::const_iterator end = citeStrings.end();
1553 for (int ii = 1; cit != end; ++cit, ++ii) {
1554 docstring label = *cit;
1555 CitationStyle cs = citeStyleList[ii - 1];
1556 cs.forceUpperCase &= force;
1557 cs.fullAuthorList &= full;
1558 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1559 FuncRequest(LFUN_INSET_MODIFY,
1560 "changetype " + from_utf8(citationStyleToString(cs)))));
1565 void MenuDefinition::expandArguments(BufferView const * bv, bool switcharg)
1570 if (!bv->cursor().inTexted())
1573 Inset const * inset = &bv->cursor().inset();
1574 Layout::LaTeXArgMap args = bv->cursor().paragraph().layout().args();
1575 if (inset && args.empty())
1576 args = inset->getLayout().args();
1577 if (args.empty() || (switcharg && args.size() == 1))
1579 Layout::LaTeXArgMap::const_iterator lait = args.begin();
1580 Layout::LaTeXArgMap::const_iterator const laend = args.end();
1581 for (; lait != laend; ++lait) {
1582 Layout::latexarg arg = (*lait).second;
1583 docstring str = arg.menustring.empty()? arg.labelstring : arg.menustring;
1584 QString item = toqstr(translateIfPossible(str));
1586 add(MenuItem(MenuItem::Command, item,
1587 FuncRequest(LFUN_INSET_MODIFY,
1588 from_ascii("changetype ")
1589 + from_ascii((*lait).first))));
1591 add(MenuItem(MenuItem::Command, item,
1592 FuncRequest(LFUN_ARGUMENT_INSERT,
1593 from_ascii((*lait).first))));
1598 void MenuDefinition::expandCaptions(Buffer const * buf, bool switchcap)
1603 vector<docstring> caps;
1604 DocumentClass const & dc = buf->params().documentClass();
1605 TextClass::InsetLayouts::const_iterator lit = dc.insetLayouts().begin();
1606 TextClass::InsetLayouts::const_iterator len = dc.insetLayouts().end();
1607 for (; lit != len; ++lit) {
1608 if (prefixIs(lit->first, from_ascii("Caption:")))
1609 caps.push_back(lit->first);
1612 if (caps.empty() || (switchcap && caps.size() == 1))
1614 if (caps.size() == 1) {
1616 docstring const type = split(*caps.begin(), dummy, ':');
1617 add(MenuItem(MenuItem::Command, qt_("Caption"),
1618 FuncRequest(LFUN_CAPTION_INSERT, translateIfPossible(type))));
1622 MenuDefinition captions;
1624 vector<docstring>::const_iterator cit = caps.begin();
1625 vector<docstring>::const_iterator end = caps.end();
1627 for (int ii = 1; cit != end; ++cit, ++ii) {
1629 docstring const type = split(*cit, dummy, ':');
1630 docstring const trtype = translateIfPossible(type);
1631 docstring const cmitem = bformat(_("Caption (%1$s)"), trtype);
1632 // make menu item optional, otherwise we would also see
1633 // forbidden caption types
1635 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cmitem),
1636 FuncRequest(LFUN_INSET_MODIFY,
1637 from_ascii("changetype ")
1638 + type), QString(), true));
1640 captions.addWithStatusCheck(MenuItem(MenuItem::Command,
1642 FuncRequest(LFUN_CAPTION_INSERT,
1643 type), QString(), true));
1645 if (!captions.empty()) {
1646 MenuItem item(MenuItem::Submenu, qt_("Caption"));
1647 item.setSubmenu(captions);
1655 /////////////////////////////////////////////////////////////////////
1656 // Menu::Impl definition and implementation
1657 /////////////////////////////////////////////////////////////////////
1661 /// populates the menu or one of its submenu
1662 /// This is used as a recursive function
1663 void populate(QMenu & qMenu, MenuDefinition const & menu);
1665 /// Only needed for top level menus.
1666 MenuDefinition * top_level_menu;
1669 /// the name of this menu
1675 /// Get a MenuDefinition item label from the menu backend
1676 static QString label(MenuItem const & mi)
1678 QString label = mi.label();
1679 label.replace("&", "&&");
1681 QString shortcut = mi.shortcut();
1682 if (!shortcut.isEmpty()) {
1683 int pos = label.indexOf(shortcut);
1685 //label.insert(pos, 1, char_type('&'));
1686 label.replace(pos, 0, "&");
1689 QString const binding = mi.binding();
1690 if (!binding.isEmpty())
1691 label += '\t' + binding;
1696 void Menu::Impl::populate(QMenu & qMenu, MenuDefinition const & menu)
1698 LYXERR(Debug::GUI, "populating menu " << menu.name());
1700 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
1703 LYXERR(Debug::GUI, " ***** menu entries " << menu.size());
1704 MenuDefinition::const_iterator m = menu.begin();
1705 MenuDefinition::const_iterator end = menu.end();
1706 for (; m != end; ++m) {
1707 if (m->kind() == MenuItem::Separator)
1708 qMenu.addSeparator();
1709 else if (m->kind() == MenuItem::Submenu) {
1710 QMenu * subMenu = qMenu.addMenu(label(*m));
1711 populate(*subMenu, m->submenu());
1712 subMenu->setEnabled(m->status().enabled());
1714 // we have a MenuItem::Command
1715 qMenu.addAction(new Action(QIcon(), label(*m),
1716 m->func(), m->tooltip(), &qMenu));
1721 #if defined(Q_WS_WIN) && (QT_VERSION >= 0x040600)
1722 class AlwaysMnemonicStyle : public QProxyStyle {
1724 int styleHint(StyleHint hint, const QStyleOption *opt = 0, const QWidget *widget = 0,
1725 QStyleHintReturn *returnData = 0) const
1727 if (hint == QStyle::SH_UnderlineShortcut)
1729 return QProxyStyle::styleHint(hint, opt, widget, returnData);
1734 /////////////////////////////////////////////////////////////////////
1735 // Menu implementation
1736 /////////////////////////////////////////////////////////////////////
1738 Menu::Menu(GuiView * gv, QString const & name, bool top_level, bool keyboard)
1739 : QMenu(gv), d(new Menu::Impl)
1741 #if defined(Q_WS_WIN) && (QT_VERSION >= 0x040600)
1743 setStyle(new AlwaysMnemonicStyle);
1747 d->top_level_menu = top_level? new MenuDefinition : 0;
1751 if (d->top_level_menu)
1752 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1758 delete d->top_level_menu;
1763 void Menu::updateView()
1765 guiApp->menus().updateMenu(this);
1771 QList<QAction *> items = actions();
1772 for (int i = 0; i != items.size(); ++i) {
1773 // QAction::menu() returns 0 if there's no submenu.
1774 delete items.at(i)->menu();
1780 /////////////////////////////////////////////////////////////////////
1781 // Menus::Impl definition and implementation
1782 /////////////////////////////////////////////////////////////////////
1784 struct Menus::Impl {
1786 bool hasMenu(QString const &) const;
1788 MenuDefinition & getMenu(QString const &);
1790 MenuDefinition const & getMenu(QString const &) const;
1792 /// Expands some special entries of the menu
1793 /** The entries with the following kind are expanded to a
1794 sequence of Command MenuItems: Lastfiles, Documents,
1795 ViewFormats, ExportFormats, UpdateFormats, Branches,
1796 Indices, Arguments, SwitchArguments, Captions, SwitchCaptions
1798 void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1799 BufferView const *) const;
1801 /// Initialize specific MACOS X menubar
1802 void macxMenuBarInit(QMenuBar * qmb);
1804 /// Mac special menu.
1805 /** This defines a menu whose entries list the FuncRequests
1806 that will be removed by expand() in other menus. This is
1807 used by the Qt/Mac code.
1809 NOTE: Qt does not remove the menu items when clearing a QMenuBar,
1810 such that the items will keep accessing the FuncRequests in
1811 the MenuDefinition. While Menus::Impl might be recreated,
1812 we keep mac_special_menu_ in memory by making it static.
1814 static MenuDefinition mac_special_menu_;
1819 MenuDefinition menubar_;
1821 typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
1823 /// name to menu for \c menu() method.
1828 MenuDefinition Menus::Impl::mac_special_menu_;
1832 Here is what the Qt documentation says about how a menubar is chosen:
1834 1) If the window has a QMenuBar then it is used. 2) If the window
1835 is a modal then its menubar is used. If no menubar is specified
1836 then a default menubar is used (as documented below) 3) If the
1837 window has no parent then the default menubar is used (as
1840 The above 3 steps are applied all the way up the parent window
1841 chain until one of the above are satisifed. If all else fails a
1842 default menubar will be created, the default menubar on Qt/Mac is
1843 an empty menubar, however you can create a different default
1844 menubar by creating a parentless QMenuBar, the first one created
1845 will thus be designated the default menubar, and will be used
1846 whenever a default menubar is needed.
1848 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1849 that this menubar will be used also when one of LyX' dialogs has
1852 void Menus::Impl::macxMenuBarInit(QMenuBar * qmb)
1854 /* Since Qt 4.2, the qt/mac menu code has special code for
1855 specifying the role of a menu entry. However, it does not
1856 work very well with our scheme of creating menus on demand,
1857 and therefore we need to put these entries in a special
1858 invisible menu. (JMarc)
1861 /* The entries of our special mac menu. If we add support for
1862 * special entries in Menus, we could imagine something
1864 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
1865 * and therefore avoid hardcoding. I am not sure it is worth
1866 * the hassle, though. (JMarc)
1868 struct MacMenuEntry {
1872 QAction::MenuRole role;
1875 static MacMenuEntry entries[] = {
1876 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1877 QAction::AboutRole},
1878 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1879 QAction::PreferencesRole},
1880 /* {LFUN_RECONFIGURE, "", "Reconfigure",
1881 QAction::ApplicationSpecificRole}, */
1882 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1884 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1885 const bool first_call = mac_special_menu_.empty();
1887 // the special menu for Menus. Fill it up only once.
1889 for (size_t i = 0 ; i < num_entries ; ++i) {
1890 FuncRequest const func(entries[i].action,
1891 from_utf8(entries[i].arg));
1892 mac_special_menu_.add(MenuItem(MenuItem::Command,
1893 entries[i].label, func));
1897 // add the entries to a QMenu that will eventually be empty
1898 // and therefore invisible.
1899 QMenu * qMenu = qmb->addMenu("special");
1900 MenuDefinition::const_iterator cit = mac_special_menu_.begin();
1901 MenuDefinition::const_iterator end = mac_special_menu_.end();
1902 for (size_t i = 0 ; cit != end ; ++cit, ++i) {
1903 #if defined(QT_MAC_USE_COCOA) && (QT_MAC_USE_COCOA > 0)
1904 if (first_call || entries[i].role != QAction::ApplicationSpecificRole) {
1905 Action * action = new Action(QIcon(), cit->label(),
1906 cit->func(), QString(), qMenu);
1907 action->setMenuRole(entries[i].role);
1908 qMenu->addAction(action);
1911 Action * action = new Action(QIcon(), cit->label(),
1912 cit->func(), QString(), qMenu);
1913 action->setMenuRole(entries[i].role);
1914 qMenu->addAction(action);
1920 void Menus::Impl::expand(MenuDefinition const & frommenu,
1921 MenuDefinition & tomenu, BufferView const * bv) const
1923 if (!tomenu.empty())
1926 for (MenuDefinition::const_iterator cit = frommenu.begin();
1927 cit != frommenu.end() ; ++cit) {
1928 Buffer const * buf = bv ? &bv->buffer() : 0;
1929 switch (cit->kind()) {
1930 case MenuItem::Lastfiles:
1931 tomenu.expandLastfiles();
1934 case MenuItem::Documents:
1935 tomenu.expandDocuments();
1938 case MenuItem::Bookmarks:
1939 tomenu.expandBookmarks();
1942 case MenuItem::ImportFormats:
1943 case MenuItem::ViewFormats:
1944 case MenuItem::UpdateFormats:
1945 case MenuItem::ExportFormats:
1946 tomenu.expandFormats(cit->kind(), buf);
1949 case MenuItem::CharStyles:
1950 tomenu.expandFlexInsert(buf, InsetLayout::CHARSTYLE);
1953 case MenuItem::Custom:
1954 tomenu.expandFlexInsert(buf, InsetLayout::CUSTOM);
1957 case MenuItem::Elements:
1958 tomenu.expandFlexInsert(buf, InsetLayout::ELEMENT);
1961 case MenuItem::FloatListInsert:
1962 tomenu.expandFloatListInsert(buf);
1965 case MenuItem::FloatInsert:
1966 tomenu.expandFloatInsert(buf);
1969 case MenuItem::PasteRecent:
1970 tomenu.expandPasteRecent(buf);
1973 case MenuItem::Toolbars:
1974 tomenu.expandToolbars();
1977 case MenuItem::Branches:
1978 tomenu.expandBranches(buf);
1981 case MenuItem::Indices:
1982 tomenu.expandIndices(buf);
1985 case MenuItem::IndicesContext:
1986 tomenu.expandIndicesContext(buf);
1989 case MenuItem::IndicesLists:
1990 tomenu.expandIndices(buf, true);
1993 case MenuItem::IndicesListsContext:
1994 tomenu.expandIndicesContext(buf, true);
1997 case MenuItem::CiteStyles:
1998 tomenu.expandCiteStyles(bv);
2002 tomenu.expandToc(buf);
2005 case MenuItem::GraphicsGroups:
2006 tomenu.expandGraphicsGroups(bv);
2009 case MenuItem::SpellingSuggestions:
2010 tomenu.expandSpellingSuggestions(bv);
2013 case MenuItem::LanguageSelector:
2014 tomenu.expandLanguageSelector(buf);
2017 case MenuItem::Arguments:
2018 tomenu.expandArguments(bv, false);
2021 case MenuItem::SwitchArguments:
2022 tomenu.expandArguments(bv, true);
2025 case MenuItem::Captions:
2026 tomenu.expandCaptions(buf, false);
2029 case MenuItem::SwitchCaptions:
2030 tomenu.expandCaptions(buf, true);
2033 case MenuItem::Submenu: {
2034 MenuItem item(*cit);
2035 item.setSubmenu(MenuDefinition(cit->submenuname()));
2036 expand(getMenu(cit->submenuname()), item.submenu(), bv);
2037 tomenu.addWithStatusCheck(item);
2041 case MenuItem::Info:
2042 case MenuItem::Help:
2043 case MenuItem::Separator:
2044 tomenu.addWithStatusCheck(*cit);
2047 case MenuItem::Command:
2048 if (!mac_special_menu_.hasFunc(cit->func()))
2049 tomenu.addWithStatusCheck(*cit);
2053 // we do not want the menu to end with a separator
2054 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
2055 tomenu.items_.pop_back();
2057 // Check whether the shortcuts are unique
2058 tomenu.checkShortcuts();
2062 bool Menus::Impl::hasMenu(QString const & name) const
2064 return find_if(menulist_.begin(), menulist_.end(),
2065 MenuNamesEqual(name)) != menulist_.end();
2069 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
2071 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
2072 MenuNamesEqual(name));
2073 if (cit == menulist_.end()) {
2074 LYXERR0("No submenu named " << name);
2075 LASSERT(false, { static const MenuDefinition m; return m; });
2081 MenuDefinition & Menus::Impl::getMenu(QString const & name)
2083 iterator it = find_if(menulist_.begin(), menulist_.end(),
2084 MenuNamesEqual(name));
2085 if (it == menulist_.end()) {
2086 LYXERR0("No submenu named " << name);
2087 LASSERT(false, { static MenuDefinition m; return m; });
2093 /////////////////////////////////////////////////////////////////////
2097 /////////////////////////////////////////////////////////////////////
2099 Menus::Menus() : d(new Impl) {}
2115 void Menus::read(Lexer & lex)
2123 LexerKeyword menutags[] = {
2124 { "end", md_endmenuset },
2125 { "menu", md_menu },
2126 { "menubar", md_menubar }
2129 // consistency check
2130 if (compare_ascii_no_case(lex.getString(), "menuset"))
2131 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
2133 lex.pushTable(menutags);
2134 lex.setContext("Menus::read");
2138 while (lex.isOK() && !quit) {
2139 switch (lex.lex()) {
2141 d->menubar_.read(lex);
2145 QString const name = toqstr(lex.getDocString());
2146 if (d->hasMenu(name))
2147 d->getMenu(name).read(lex);
2149 MenuDefinition menu(name);
2151 d->menulist_.push_back(menu);
2159 lex.printError("Unknown menu tag");
2167 bool Menus::searchMenu(FuncRequest const & func,
2168 docstring_list & names) const
2170 MenuDefinition menu;
2171 d->expand(d->menubar_, menu, 0);
2172 return menu.searchMenu(func, names);
2176 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
2180 // setup special mac specific menu items, but only do this
2181 // the first time a QMenuBar is created. Otherwise Qt will
2182 // create duplicate items in the application menu. It seems
2183 // that Qt does not remove them when the QMenubar is cleared.
2184 LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
2185 d->macxMenuBarInit(qmb);
2188 // Clear all menubar contents before filling it.
2192 LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
2194 if (d->menubar_.empty()) {
2195 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
2196 << d->menubar_.name());
2199 LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
2201 MenuDefinition menu;
2202 BufferView * bv = 0;
2204 bv = view->currentBufferView();
2205 d->expand(d->menubar_, menu, bv);
2207 MenuDefinition::const_iterator m = menu.begin();
2208 MenuDefinition::const_iterator end = menu.end();
2210 for (; m != end; ++m) {
2212 if (m->kind() != MenuItem::Submenu) {
2213 LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
2217 LYXERR(Debug::GUI, "menu bar item " << m->label()
2218 << " is a submenu named " << m->submenuname());
2220 QString name = m->submenuname();
2221 if (!d->hasMenu(name)) {
2222 LYXERR(Debug::GUI, "\tERROR: " << name
2223 << " submenu has no menu!");
2227 Menu * menu = new Menu(view, m->submenuname(), true);
2228 menu->setTitle(label(*m));
2231 d->name_map_[view][name] = menu;
2236 void Menus::updateMenu(Menu * qmenu)
2238 LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
2241 if (qmenu->d->name.isEmpty())
2244 docstring identifier = qstring_to_ucs4(qmenu->d->name);
2245 MenuDefinition fromLyxMenu(qmenu->d->name);
2246 while (!identifier.empty()) {
2247 docstring menu_name;
2248 identifier = split(identifier, menu_name, ';');
2250 if (!d->hasMenu(toqstr(menu_name))) {
2251 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
2256 MenuDefinition cat_menu = d->getMenu(toqstr(menu_name));
2257 //FIXME: 50 is a wild guess. We should take into account here
2258 //the expansion of menu items, disabled optional items etc.
2259 bool const in_sub_menu = !fromLyxMenu.empty()
2260 && fromLyxMenu.size() + cat_menu.size() > 50 ;
2262 fromLyxMenu.catSub(menu_name);
2264 fromLyxMenu.cat(cat_menu);
2265 fromLyxMenu.add(MenuItem(MenuItem::Separator));
2268 if (fromLyxMenu.empty()) {
2269 qmenu->addAction(qt_("No Action Defined!"));
2273 BufferView * bv = 0;
2275 bv = qmenu->d->view->currentBufferView();
2276 d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
2277 qmenu->d->populate(*qmenu, *qmenu->d->top_level_menu);
2281 Menu * Menus::menu(QString const & name, GuiView & view, bool keyboard)
2283 LYXERR(Debug::GUI, "Context menu requested: " << name);
2284 Menu * menu = d->name_map_[&view].value(name, 0);
2285 if (!menu && !name.startsWith("context-")) {
2286 LYXERR0("requested context menu not found: " << name);
2290 menu = new Menu(&view, name, true, keyboard);
2291 d->name_map_[&view][name] = menu;
2295 } // namespace frontend
2298 #include "moc_Menus.cpp"