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"
44 #include "LyXAction.h"
48 #include "Paragraph.h"
49 #include "ParIterator.h"
51 #include "SpellChecker.h"
52 #include "TextClass.h"
53 #include "TocBackend.h"
55 #include "WordLangTuple.h"
57 #include "insets/Inset.h"
58 #include "insets/InsetCitation.h"
59 #include "insets/InsetGraphics.h"
61 #include "support/lassert.h"
62 #include "support/convert.h"
63 #include "support/debug.h"
64 #include "support/docstring_list.h"
65 #include "support/filetools.h"
66 #include "support/gettext.h"
67 #include "support/lstrings.h"
74 #if QT_VERSION >= 0x040600
75 #include <QProxyStyle>
78 #include "support/shared_ptr.h"
84 using namespace lyx::support;
92 // MacOSX specific stuff is at the end.
99 /// The type of elements that can be in a menu
107 /** This type of item explains why something is unavailable. If this
108 menuitem is in a submenu, the submenu is enabled to make sure the
109 user sees the information. */
111 /** This type of item merely shows that there might be a list or
112 something alike at this position, but the list is still empty.
113 If this item is in a submenu, the submenu will not always be
116 /** This is the list of last opened file,
117 typically for the File menu. */
119 /** This is the list of opened Documents,
120 typically for the Documents menu. */
122 /** This is the bookmarks */
126 /** This is a list of viewable formats
127 typically for the File->View menu. */
129 /** This is a list of updatable formats
130 typically for the File->Update menu. */
132 /** This is a list of exportable formats
133 typically for the File->Export menu. */
135 /** This is a list of importable formats
136 typically for the File->Import menu. */
138 /** This is the list of elements available
139 * for insertion into document. */
141 /** This is the list of user-configurable
142 insets to insert into document */
144 /** This is the list of XML elements to
145 insert into the document */
147 /** This is the list of floats that we can
148 insert a list for. */
150 /** This is the list of floats that we can
153 /** This is the list of selections that can
158 /** Available branches in document */
160 /** Available indices in document */
162 /** Context menu for indices in document */
164 /** Available index lists in document */
166 /** Context menu for available indices lists in document */
168 /** Available citation styles for a given citation */
170 /** Available graphics groups */
172 /// Words suggested by the spellchecker.
174 /** Used Languages */
178 explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
181 QString const & label,
182 QString const & submenu = QString(),
183 QString const & tooltip = QString(),
184 bool optional = false)
185 : kind_(kind), label_(label), submenuname_(submenu),
186 tooltip_(tooltip), optional_(optional)
188 LASSERT(kind == Submenu || kind == Help || kind == Info, /**/);
192 QString const & label,
193 FuncRequest const & func,
194 QString const & tooltip = QString(),
195 bool optional = false,
196 FuncRequest::Origin origin = FuncRequest::MENU)
197 : kind_(kind), label_(label), func_(func),
198 tooltip_(tooltip), optional_(optional)
200 func_.setOrigin(origin);
203 // shared_ptr<MenuDefinition> needs this apprently...
206 /// The label of a given menuitem
207 QString label() const
209 int const index = label_.lastIndexOf('|');
210 return index == -1 ? label_ : label_.left(index);
213 /// The keyboard shortcut (usually underlined in the entry)
214 QString shortcut() const
216 int const index = label_.lastIndexOf('|');
217 return index == -1 ? QString() : label_.mid(index + 1);
219 /// The complete label, with label and shortcut separated by a '|'
220 QString fulllabel() const { return label_; }
221 /// The kind of entry
222 Kind kind() const { return kind_; }
223 /// the action (if relevant)
224 FuncRequest const & func() const { return func_; }
226 QString const & tooltip() const { return tooltip_; }
227 /// returns true if the entry should be omitted when disabled
228 bool optional() const { return optional_; }
229 /// returns the status of the lfun associated with this entry
230 FuncStatus const & status() const { return status_; }
231 /// returns the status of the lfun associated with this entry
232 FuncStatus & status() { return status_; }
233 /// returns the status of the lfun associated with this entry
234 void status(FuncStatus const & status) { status_ = status; }
236 ///returns the binding associated to this action.
237 QString binding() const
239 if (kind_ != Command)
241 // Get the keys bound to this action, but keep only the
243 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
245 return toqstr(bindings.begin()->print(KeySequence::ForGui));
247 LYXERR(Debug::KBMAP, "No binding for "
248 << lyxaction.getActionName(func_.action())
249 << '(' << func_.argument() << ')');
253 /// the description of the submenu (if relevant)
254 QString const & submenuname() const { return submenuname_; }
255 /// set the description of the submenu
256 void submenuname(QString const & name) { submenuname_ = name; }
258 bool hasSubmenu() const { return !submenu_.isEmpty(); }
260 MenuDefinition const & submenu() const { return submenu_.at(0); }
261 MenuDefinition & submenu() { return submenu_[0]; }
263 void setSubmenu(MenuDefinition const & menu)
266 submenu_.append(menu);
277 QString submenuname_;
284 /// contains 0 or 1 item.
285 QList<MenuDefinition> submenu_;
289 class MenuDefinition {
292 typedef std::vector<MenuItem> ItemList;
294 typedef ItemList::const_iterator const_iterator;
296 explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
301 QString const & name() const { return name_; }
303 bool empty() const { return items_.empty(); }
304 /// Clear the menu content.
305 void clear() { items_.clear(); }
307 size_t size() const { return items_.size(); }
309 MenuItem const & operator[](size_t) const;
311 const_iterator begin() const { return items_.begin(); }
313 const_iterator end() const { return items_.end(); }
315 void cat(MenuDefinition const & other);
317 void catSub(docstring const & name);
319 // search for func in this menu iteratively, and put menu
321 bool searchMenu(FuncRequest const & func, docstring_list & names)
324 bool hasFunc(FuncRequest const &) const;
325 /// Add the menu item unconditionally
326 void add(MenuItem const & item) { items_.push_back(item); }
327 /// Checks the associated FuncRequest status before adding the
329 void addWithStatusCheck(MenuItem const &);
330 // Check whether the menu shortcuts are unique
331 void checkShortcuts() const;
333 void expandLastfiles();
334 void expandDocuments();
335 void expandBookmarks();
336 void expandFormats(MenuItem::Kind const kind, Buffer const * buf);
337 void expandFloatListInsert(Buffer const * buf);
338 void expandFloatInsert(Buffer const * buf);
339 void expandFlexInsert(Buffer const * buf, InsetLayout::InsetLyXType type);
340 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth);
341 void expandToc(Buffer const * buf);
342 void expandPasteRecent(Buffer const * buf);
343 void expandToolbars();
344 void expandBranches(Buffer const * buf);
345 void expandIndices(Buffer const * buf, bool listof = false);
346 void expandIndicesContext(Buffer const * buf, bool listof = false);
347 void expandCiteStyles(BufferView const *);
348 void expandGraphicsGroups(BufferView const *);
349 void expandSpellingSuggestions(BufferView const *);
350 void expandLanguageSelector(Buffer const * buf);
358 /// Helper for std::find_if
362 MenuNamesEqual(QString const & name) : name_(name) {}
363 bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
370 typedef std::vector<MenuDefinition> MenuList;
372 typedef MenuList::const_iterator const_iterator;
374 typedef MenuList::iterator iterator;
376 /////////////////////////////////////////////////////////////////////
377 // MenuDefinition implementation
378 /////////////////////////////////////////////////////////////////////
380 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
384 case MenuItem::Command: {
385 FuncStatus status = lyx::getStatus(i.func());
386 if (status.unknown() || (!status.enabled() && i.optional()))
389 items_.back().status(status);
393 case MenuItem::Submenu: {
394 bool enabled = false;
395 if (i.hasSubmenu()) {
396 for (const_iterator cit = i.submenu().begin();
397 cit != i.submenu().end(); ++cit) {
398 // Only these kind of items affect the status of the submenu
399 if ((cit->kind() == MenuItem::Command
400 || cit->kind() == MenuItem::Submenu
401 || cit->kind() == MenuItem::Help)
402 && cit->status().enabled()) {
408 if (enabled || !i.optional()) {
410 items_.back().status().setEnabled(enabled);
415 case MenuItem::Separator:
416 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
426 void MenuDefinition::read(Lexer & lex)
443 md_indiceslistscontext,
457 md_spellingsuggestions,
461 LexerKeyword menutags[] = {
462 { "bookmarks", md_bookmarks },
463 { "branches", md_branches },
464 { "charstyles", md_charstyles },
465 { "citestyles", md_citestyles },
466 { "custom", md_custom },
467 { "documents", md_documents },
468 { "elements", md_elements },
469 { "end", md_endmenu },
470 { "exportformats", md_exportformats },
471 { "floatinsert", md_floatinsert },
472 { "floatlistinsert", md_floatlistinsert },
473 { "graphicsgroups", md_graphicsgroups },
474 { "importformats", md_importformats },
475 { "indices", md_indices },
476 { "indicescontext", md_indicescontext },
477 { "indiceslists", md_indiceslists },
478 { "indiceslistscontext", md_indiceslistscontext },
480 { "languageselector", md_languageselector },
481 { "lastfiles", md_lastfiles },
482 { "optitem", md_optitem },
483 { "optsubmenu", md_optsubmenu },
484 { "pasterecent", md_pasterecent },
485 { "separator", md_separator },
486 { "spellingsuggestions", md_spellingsuggestions },
487 { "submenu", md_submenu },
489 { "toolbars", md_toolbars },
490 { "updateformats", md_updateformats },
491 { "viewformats", md_viewformats }
494 lex.pushTable(menutags);
495 lex.setContext("MenuDefinition::read: ");
498 bool optional = false;
500 while (lex.isOK() && !quit) {
504 // fallback to md_item
507 docstring const name = translateIfPossible(lex.getDocString());
509 string const command = lex.getString();
510 FuncRequest func = lyxaction.lookupFunc(command);
511 FuncRequest::Origin origin = FuncRequest::MENU;
512 if (name_.startsWith("context-toc-"))
513 origin = FuncRequest::TOC;
514 add(MenuItem(MenuItem::Command, toqstr(name), func, QString(), optional, origin));
520 add(MenuItem(MenuItem::Separator));
524 add(MenuItem(MenuItem::Lastfiles));
528 add(MenuItem(MenuItem::CharStyles));
532 add(MenuItem(MenuItem::Custom));
536 add(MenuItem(MenuItem::Elements));
540 add(MenuItem(MenuItem::Documents));
544 add(MenuItem(MenuItem::Bookmarks));
548 add(MenuItem(MenuItem::Toc));
552 add(MenuItem(MenuItem::ViewFormats));
555 case md_updateformats:
556 add(MenuItem(MenuItem::UpdateFormats));
559 case md_exportformats:
560 add(MenuItem(MenuItem::ExportFormats));
563 case md_importformats:
564 add(MenuItem(MenuItem::ImportFormats));
567 case md_floatlistinsert:
568 add(MenuItem(MenuItem::FloatListInsert));
572 add(MenuItem(MenuItem::FloatInsert));
576 add(MenuItem(MenuItem::PasteRecent));
580 add(MenuItem(MenuItem::Toolbars));
584 add(MenuItem(MenuItem::Branches));
588 add(MenuItem(MenuItem::CiteStyles));
591 case md_graphicsgroups:
592 add(MenuItem(MenuItem::GraphicsGroups));
595 case md_spellingsuggestions:
596 add(MenuItem(MenuItem::SpellingSuggestions));
599 case md_languageselector:
600 add(MenuItem(MenuItem::LanguageSelector));
604 add(MenuItem(MenuItem::Indices));
607 case md_indicescontext:
608 add(MenuItem(MenuItem::IndicesContext));
611 case md_indiceslists:
612 add(MenuItem(MenuItem::IndicesLists));
615 case md_indiceslistscontext:
616 add(MenuItem(MenuItem::IndicesListsContext));
621 // fallback to md_submenu
624 docstring const mlabel = translateIfPossible(lex.getDocString());
626 docstring const mname = lex.getDocString();
627 add(MenuItem(MenuItem::Submenu,
628 toqstr(mlabel), toqstr(mname), QString(), optional));
638 lex.printError("Unknown menu tag");
646 MenuItem const & MenuDefinition::operator[](size_type i) const
652 bool MenuDefinition::hasFunc(FuncRequest const & func) const
654 for (const_iterator it = begin(), et = end(); it != et; ++it)
655 if (it->func() == func)
661 void MenuDefinition::catSub(docstring const & name)
663 add(MenuItem(MenuItem::Submenu,
664 qt_("More...|M"), toqstr(name), QString(), false));
667 void MenuDefinition::cat(MenuDefinition const & other)
669 const_iterator et = other.end();
670 for (const_iterator it = other.begin(); it != et; ++it)
675 void MenuDefinition::checkShortcuts() const
677 // This is a quadratic algorithm, but we do not care because
678 // menus are short enough
679 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
680 QString shortcut = it1->shortcut();
681 if (shortcut.isEmpty())
683 if (!it1->label().contains(shortcut))
684 LYXERR0("Menu warning: menu entry \""
686 << "\" does not contain shortcut `"
687 << shortcut << "'.");
688 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
689 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
690 LYXERR0("Menu warning: menu entries "
691 << '"' << it1->fulllabel()
692 << "\" and \"" << it2->fulllabel()
693 << "\" share the same shortcut.");
700 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
702 const_iterator m = begin();
703 const_iterator m_end = end();
704 for (; m != m_end; ++m) {
705 if (m->kind() == MenuItem::Command && m->func() == func) {
706 names.push_back(qstring_to_ucs4(m->label()));
709 if (m->kind() == MenuItem::Submenu) {
710 names.push_back(qstring_to_ucs4(m->label()));
711 if (!m->hasSubmenu()) {
712 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
713 << m->label() << " name=" << m->submenuname());
717 if (m->submenu().searchMenu(func, names))
726 QString limitStringLength(docstring const & str)
728 size_t const max_item_length = 45;
730 if (str.size() > max_item_length)
731 return toqstr(str.substr(0, max_item_length - 3) + "...");
737 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
742 graphics::getGraphicsGroups(bv->buffer(), grp);
746 set<string>::const_iterator it = grp.begin();
747 set<string>::const_iterator end = grp.end();
748 add(MenuItem(MenuItem::Command, qt_("No Group"),
749 FuncRequest(LFUN_SET_GRAPHICS_GROUP)));
750 for (; it != end; it++) {
751 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it) + '|',
752 FuncRequest(LFUN_SET_GRAPHICS_GROUP, *it)));
757 void MenuDefinition::expandSpellingSuggestions(BufferView const * bv)
761 Cursor const & cur = bv->cursor();
765 docstring_list suggestions;
766 Paragraph const & par = cur.paragraph();
767 pos_type from = cur.pos();
769 SpellChecker::Result res = par.spellCheck(from, to, wl, suggestions, true, true);
771 case SpellChecker::UNKNOWN_WORD:
772 if (lyxrc.spellcheck_continuously) {
773 LYXERR(Debug::GUI, "Misspelled Word! Suggested Words = ");
774 docstring const & selection = cur.selectionAsString(false);
775 if (!cur.selection() || selection == wl.word()) {
777 size_t m = 10; // first submenu index
778 MenuItem item(MenuItem::Submenu, qt_("More Spelling Suggestions"));
779 item.setSubmenu(MenuDefinition(qt_("More Spelling Suggestions")));
780 for (; i != suggestions.size(); ++i) {
781 docstring const & suggestion = suggestions[i];
782 LYXERR(Debug::GUI, suggestion);
783 MenuItem w(MenuItem::Command, toqstr(suggestion),
784 FuncRequest(LFUN_WORD_REPLACE,
785 replace2string(suggestion, selection,
786 true, true, false, true, false)));
790 item.submenu().add(w);
795 add(MenuItem(MenuItem::Separator));
796 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
797 add(MenuItem(MenuItem::Command, qt_("Add to personal dictionary|n"),
798 FuncRequest(LFUN_SPELLING_ADD, arg)));
799 add(MenuItem(MenuItem::Command, qt_("Ignore all|I"),
800 FuncRequest(LFUN_SPELLING_IGNORE, arg)));
804 case SpellChecker::LEARNED_WORD: {
805 LYXERR(Debug::GUI, "Learned Word.");
806 docstring const arg = wl.word() + " " + from_ascii(wl.lang()->lang());
807 add(MenuItem(MenuItem::Command, qt_("Remove from personal dictionary|r"),
808 FuncRequest(LFUN_SPELLING_REMOVE, arg)));
811 case SpellChecker::WORD_OK:
812 case SpellChecker::COMPOUND_WORD:
813 case SpellChecker::ROOT_FOUND:
814 case SpellChecker::IGNORED_WORD:
819 struct sortLanguageByName {
820 bool operator()(const Language * a, const Language * b) const {
821 return qt_(a->display()).localeAwareCompare(qt_(b->display())) < 0;
825 void MenuDefinition::expandLanguageSelector(Buffer const * buf)
830 std::set<Language const *> languages_buffer =
831 buf->masterBuffer()->getLanguages();
833 if (languages_buffer.size() < 2)
836 std::set<Language const *, sortLanguageByName> languages;
838 std::set<Language const *>::const_iterator const beg =
839 languages_buffer.begin();
840 for (std::set<Language const *>::const_iterator cit = beg;
841 cit != languages_buffer.end(); ++cit) {
842 languages.insert(*cit);
845 MenuItem item(MenuItem::Submenu, qt_("Language|L"));
846 item.setSubmenu(MenuDefinition(qt_("Language")));
847 QString morelangs = qt_("More Languages ...|M");
848 QStringList accelerators;
849 if (morelangs.contains('|'))
850 accelerators.append(morelangs.section('|', -1));
851 std::set<Language const *, sortLanguageByName>::const_iterator const begin = languages.begin();
852 for (std::set<Language const *, sortLanguageByName>::const_iterator cit = begin;
853 cit != languages.end(); ++cit) {
854 QString label = qt_((*cit)->display());
855 // try to add an accelerator
856 bool success = false;
857 // try capitals first
858 for (int i = 0; i < label.size(); ++i) {
859 QChar const ch = label[i];
862 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
863 label = label + toqstr("|") + ch;
864 accelerators.append(ch);
869 // if all capitals are taken, try the rest
871 for (int i = 0; i < label.size(); ++i) {
872 if (label[i].isSpace())
874 QString const ch = QString(label[i]);
875 if (!accelerators.contains(ch, Qt::CaseInsensitive)) {
876 label = label + toqstr("|") + ch;
877 accelerators.append(ch);
882 MenuItem w(MenuItem::Command, label,
883 FuncRequest(LFUN_LANGUAGE, (*cit)->lang()));
884 item.submenu().addWithStatusCheck(w);
886 item.submenu().add(MenuItem(MenuItem::Separator));
887 item.submenu().add(MenuItem(MenuItem::Command, morelangs,
888 FuncRequest(LFUN_DIALOG_SHOW, "character")));
893 void MenuDefinition::expandLastfiles()
895 LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
896 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
900 for (; lfit != lf.end() && ii <= lyxrc.num_lastfiles; ++lfit, ++ii) {
901 string const file = lfit->absFileName();
902 QString const short_path = toqstr(makeDisplayPath(file, 30));
903 QString const long_path = toqstr(makeDisplayPath(file));
906 label = QString("%1. %2|%3").arg(ii).arg(short_path).arg(ii);
908 label = QString("%1. %2").arg(ii).arg(short_path);
909 add(MenuItem(MenuItem::Command, label,
910 FuncRequest(LFUN_FILE_OPEN, file), long_path));
915 void MenuDefinition::expandDocuments()
917 MenuItem item(MenuItem::Submenu, qt_("Hidden|H"));
918 item.setSubmenu(MenuDefinition(qt_("Hidden|H")));
920 Buffer * first = theBufferList().first();
922 add(MenuItem(MenuItem::Info, qt_("<No Documents Open>")));
928 if (!guiApp->currentView())
930 GuiWorkArea * wa = guiApp->currentView()->workArea(i);
933 Buffer const & b = wa->bufferView().buffer();
934 QString label = toqstr(b.fileName().displayName(20));
938 label = QString::number(i) + ". " + label + '|' + QString::number(i);
939 add(MenuItem(MenuItem::Command, label,
940 FuncRequest(LFUN_BUFFER_SWITCH, b.absFileName())));
947 // We cannot use a for loop as the buffer list cycles.
949 bool const shown = guiApp->currentView()
950 ? guiApp->currentView()->workArea(*b) : false;
952 QString label = toqstr(b->fileName().displayName(20));
956 label = QString::number(i) + ". " + label + '|' + QString::number(i);
957 item.submenu().add(MenuItem(MenuItem::Command, label,
958 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
961 b = theBufferList().next(b);
962 } while (b != first);
964 if (!item.submenu().empty())
969 void MenuDefinition::expandBookmarks()
971 lyx::BookmarksSection const & bm = theSession().bookmarks();
974 for (size_t i = 1; i <= bm.size(); ++i) {
976 string const file = bm.bookmark(i).filename.absFileName();
977 QString const label = QString("%1. %2|%3").arg(i)
978 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
979 add(MenuItem(MenuItem::Command, label,
980 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
985 add(MenuItem(MenuItem::Info, qt_("<No Bookmarks Saved Yet>")));
989 void MenuDefinition::expandFormats(MenuItem::Kind const kind, Buffer const * buf)
991 if (!buf && kind != MenuItem::ImportFormats)
994 typedef vector<Format const *> Formats;
996 FuncCode action = LFUN_NOACTION;
999 case MenuItem::ImportFormats:
1000 formats = theConverters().importableFormats();
1001 action = LFUN_BUFFER_IMPORT;
1003 case MenuItem::ViewFormats:
1004 formats = buf->params().exportableFormats(true);
1005 action = LFUN_BUFFER_VIEW;
1007 case MenuItem::UpdateFormats:
1008 formats = buf->params().exportableFormats(true);
1009 action = LFUN_BUFFER_UPDATE;
1011 case MenuItem::ExportFormats:
1012 formats = buf->params().exportableFormats(false);
1013 action = LFUN_BUFFER_EXPORT;
1016 LASSERT(false, /* */);
1020 bool const view_update = (kind == MenuItem::ViewFormats
1021 || kind == MenuItem::UpdateFormats);
1025 smenue = (kind == MenuItem::ViewFormats
1026 ? qt_("View (Other Formats)|F")
1027 : qt_("Update (Other Formats)|p"));
1028 MenuItem item(MenuItem::Submenu, smenue);
1029 item.setSubmenu(MenuDefinition(smenue));
1031 Formats::const_iterator fit = formats.begin();
1032 Formats::const_iterator end = formats.end();
1033 for (; fit != end ; ++fit) {
1034 if ((*fit)->dummy())
1037 docstring lab = from_utf8((*fit)->prettyname());
1038 docstring const scut = from_utf8((*fit)->shortcut());
1039 docstring const tmplab = lab;
1042 lab += char_type('|') + scut;
1043 docstring const lab_i18n = translateIfPossible(lab);
1044 docstring const shortcut = split(lab_i18n, lab, '|');
1046 bool const untranslated = (lab == lab_i18n);
1047 docstring label = untranslated ? translateIfPossible(tmplab) : lab;
1050 case MenuItem::ImportFormats:
1051 label += from_ascii("...");
1053 case MenuItem::ViewFormats:
1054 case MenuItem::UpdateFormats:
1055 if ((*fit)->name() == buf->params().getDefaultOutputFormat()) {
1056 docstring lbl = (kind == MenuItem::ViewFormats
1057 ? bformat(_("View [%1$s]|V"), label)
1058 : bformat(_("Update [%1$s]|U"), label));
1059 add(MenuItem(MenuItem::Command, toqstr(lbl), FuncRequest(action)));
1063 case MenuItem::ExportFormats:
1064 if (!(*fit)->inExportMenu())
1068 LASSERT(false, /* */);
1071 if (!shortcut.empty())
1072 label += '|' + shortcut;
1076 item.submenu().addWithStatusCheck(MenuItem(MenuItem::Command,
1077 toqstr(label), FuncRequest(action, (*fit)->name())));
1079 item.submenu().add(MenuItem(MenuItem::Command, toqstr(label),
1080 FuncRequest(action, (*fit)->name())));
1083 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1084 FuncRequest(action, (*fit)->name())));
1086 add(MenuItem(MenuItem::Command, toqstr(label),
1087 FuncRequest(action, (*fit)->name())));
1095 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
1100 FloatList const & floats = buf->params().documentClass().floats();
1101 FloatList::const_iterator cit = floats.begin();
1102 FloatList::const_iterator end = floats.end();
1104 for (; cit != end; ++cit) {
1105 if (!cit->second.usesFloatPkg()) {
1106 // Different floats could declare the same ListCommand. We only
1107 // want it on the list once, though.
1108 string const & list_cmd = cit->second.listCommand();
1109 if (list_cmd.empty())
1110 // we do not know how to generate such a list
1112 // This form of insert returns an iterator pointing to the newly
1113 // inserted element OR the existing element with that value, and
1114 // a bool indicating whether we inserted a new element. So we can
1115 // see if one is there and insert it if not all at once.
1116 pair<set<string>::iterator, bool> ret = seen.insert(list_cmd);
1120 string const & list_name = cit->second.listName();
1121 addWithStatusCheck(MenuItem(MenuItem::Command, qt_(list_name),
1122 FuncRequest(LFUN_FLOAT_LIST_INSERT, cit->second.floattype())));
1127 void MenuDefinition::expandFloatInsert(Buffer const * buf)
1132 FloatList const & floats = buf->params().documentClass().floats();
1133 FloatList::const_iterator cit = floats.begin();
1134 FloatList::const_iterator end = floats.end();
1135 for (; cit != end; ++cit) {
1137 QString const label = qt_(cit->second.name());
1138 addWithStatusCheck(MenuItem(MenuItem::Command, label,
1139 FuncRequest(LFUN_FLOAT_INSERT,
1140 cit->second.floattype())));
1145 void MenuDefinition::expandFlexInsert(
1146 Buffer const * buf, InsetLayout::InsetLyXType type)
1151 TextClass::InsetLayouts const & insetLayouts =
1152 buf->params().documentClass().insetLayouts();
1153 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
1154 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
1155 for (; cit != end; ++cit) {
1156 if (cit->second.lyxtype() == type) {
1157 docstring label = cit->first;
1158 // we remove the "Flex:" prefix, if it is present
1159 if (prefixIs(label, from_utf8("Flex:")))
1160 label = label.substr(5);
1161 addWithStatusCheck(MenuItem(MenuItem::Command,
1162 toqstr(translateIfPossible(label)),
1163 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(label))));
1166 // FIXME This is a little clunky.
1167 if (items_.empty() && type == InsetLayout::CUSTOM)
1168 add(MenuItem(MenuItem::Help, qt_("No Custom Insets Defined!")));
1172 size_t const max_number_of_items = 25;
1174 void MenuDefinition::expandToc2(Toc const & toc_list,
1175 size_t from, size_t to, int depth)
1177 int shortcut_count = 0;
1179 // check whether depth is smaller than the smallest depth in toc.
1180 int min_depth = 1000;
1181 for (size_t i = from; i < to; ++i)
1182 min_depth = min(min_depth, toc_list[i].depth());
1183 if (min_depth > depth)
1186 if (to - from <= max_number_of_items) {
1187 for (size_t i = from; i < to; ++i) {
1188 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
1189 label += limitStringLength(toc_list[i].str());
1190 if (toc_list[i].depth() == depth) {
1192 if (shortcut_count < 9) {
1193 if (label.contains(QString::number(shortcut_count + 1)))
1194 label += QString::number(++shortcut_count);
1197 add(MenuItem(MenuItem::Command, label,
1198 FuncRequest(toc_list[i].action())));
1203 size_t new_pos = pos + 1;
1204 while (new_pos < to && toc_list[new_pos].depth() > depth)
1207 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
1208 label += limitStringLength(toc_list[pos].str());
1209 if (toc_list[pos].depth() == depth) {
1211 if (shortcut_count < 9) {
1212 if (label.contains(QString::number(shortcut_count + 1)))
1213 label += QString::number(++shortcut_count);
1216 if (new_pos == pos + 1) {
1217 add(MenuItem(MenuItem::Command,
1218 label, FuncRequest(toc_list[pos].action())));
1221 sub.expandToc2(toc_list, pos, new_pos, depth + 1);
1222 MenuItem item(MenuItem::Submenu, label);
1223 item.setSubmenu(sub);
1232 void MenuDefinition::expandToc(Buffer const * buf)
1234 // To make things very cleanly, we would have to pass buf to
1235 // all MenuItem constructors and to expandToc2. However, we
1236 // know that all the entries in a TOC will be have status_ ==
1237 // OK, so we avoid this unnecessary overhead (JMarc)
1240 add(MenuItem(MenuItem::Info, qt_("<No Document Open>")));
1244 // Add an entry for the master doc if this is a child doc
1245 Buffer const * const master = buf->masterBuffer();
1246 if (buf != master) {
1247 ParIterator const pit = par_iterator_begin(master->inset());
1248 string const arg = convert<string>(pit->id());
1249 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
1250 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
1253 MenuDefinition other_lists;
1255 FloatList const & floatlist = buf->params().documentClass().floats();
1256 TocList const & toc_list = buf->tocBackend().tocs();
1257 TocList::const_iterator cit = toc_list.begin();
1258 TocList::const_iterator end = toc_list.end();
1259 for (; cit != end; ++cit) {
1260 // Handle this later
1261 if (cit->first == "tableofcontents")
1264 MenuDefinition submenu;
1265 if (cit->second.size() >= 30) {
1266 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
1267 submenu.add(MenuItem(MenuItem::Command, qt_("Open Navigator..."), f));
1269 TocIterator ccit = cit->second.begin();
1270 TocIterator eend = cit->second.end();
1271 for (; ccit != eend; ++ccit) {
1272 submenu.add(MenuItem(MenuItem::Command,
1273 limitStringLength(ccit->str()) + '|',
1274 FuncRequest(ccit->action())));
1278 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
1279 item.setSubmenu(submenu);
1280 if (floatlist.typeExist(cit->first) || cit->first == "child") {
1281 // Those two types deserve to be in the main menu.
1282 item.setSubmenu(submenu);
1285 other_lists.add(item);
1287 if (!other_lists.empty()) {
1288 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
1289 item.setSubmenu(other_lists);
1293 // Handle normal TOC
1294 cit = toc_list.find("tableofcontents");
1296 LYXERR(Debug::GUI, "No table of contents.");
1298 if (cit->second.size() > 0 )
1299 expandToc2(cit->second, 0, cit->second.size(), 0);
1301 add(MenuItem(MenuItem::Info, qt_("<Empty Table of Contents>")));
1306 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1308 docstring_list const sel = cap::availableSelections(buf);
1310 docstring_list::const_iterator cit = sel.begin();
1311 docstring_list::const_iterator end = sel.end();
1313 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1314 add(MenuItem(MenuItem::Command, toqstr(*cit) + '|',
1315 FuncRequest(LFUN_PASTE, convert<string>(index))));
1320 void MenuDefinition::expandToolbars()
1322 MenuDefinition other_lists;
1323 // extracts the toolbars from the backend
1324 Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1325 Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1326 for (; cit != end; ++cit) {
1327 MenuItem const item(MenuItem::Command, toqstr(cit->gui_name),
1328 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1329 if (guiApp->toolbars().isMainToolbar(cit->name))
1332 other_lists.add(item);
1335 if (!other_lists.empty()) {
1336 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1337 item.setSubmenu(other_lists);
1343 void MenuDefinition::expandBranches(Buffer const * buf)
1348 BufferParams const & master_params = buf->masterBuffer()->params();
1349 BufferParams const & params = buf->params();
1350 if (params.branchlist().empty() && master_params.branchlist().empty() ) {
1351 add(MenuItem(MenuItem::Help, qt_("No Branches Set for Document!")));
1355 BranchList::const_iterator cit = master_params.branchlist().begin();
1356 BranchList::const_iterator end = master_params.branchlist().end();
1358 for (int ii = 1; cit != end; ++cit, ++ii) {
1359 docstring label = cit->branch();
1361 label = convert<docstring>(ii) + ". " + label
1362 + char_type('|') + convert<docstring>(ii);
1364 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1365 FuncRequest(LFUN_BRANCH_INSERT,
1369 if (buf == buf->masterBuffer())
1372 MenuDefinition child_branches;
1374 BranchList::const_iterator ccit = params.branchlist().begin();
1375 BranchList::const_iterator cend = params.branchlist().end();
1377 for (int ii = 1; ccit != cend; ++ccit, ++ii) {
1378 docstring label = ccit->branch();
1380 label = convert<docstring>(ii) + ". " + label
1381 + char_type('|') + convert<docstring>(ii);
1383 label += char_type('|');
1384 child_branches.addWithStatusCheck(MenuItem(MenuItem::Command,
1386 FuncRequest(LFUN_BRANCH_INSERT,
1390 if (!child_branches.empty()) {
1391 MenuItem item(MenuItem::Submenu, qt_("Child Document"));
1392 item.setSubmenu(child_branches);
1398 void MenuDefinition::expandIndices(Buffer const * buf, bool listof)
1403 BufferParams const & params = buf->masterBuffer()->params();
1404 if (!params.use_indices) {
1406 addWithStatusCheck(MenuItem(MenuItem::Command,
1407 qt_("Index List|I"),
1408 FuncRequest(LFUN_INDEX_PRINT,
1409 from_ascii("idx"))));
1411 addWithStatusCheck(MenuItem(MenuItem::Command,
1412 qt_("Index Entry|d"),
1413 FuncRequest(LFUN_INDEX_INSERT,
1414 from_ascii("idx"))));
1418 if (params.indiceslist().empty())
1421 IndicesList::const_iterator cit = params.indiceslist().begin();
1422 IndicesList::const_iterator end = params.indiceslist().end();
1424 for (int ii = 1; cit != end; ++cit, ++ii) {
1426 docstring const label =
1427 bformat(_("Index: %1$s"), cit->index());
1428 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1429 FuncRequest(LFUN_INDEX_PRINT, cit->shortcut())));
1431 docstring const label =
1432 bformat(_("Index Entry (%1$s)"), cit->index());
1433 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1434 FuncRequest(LFUN_INDEX_INSERT, cit->shortcut())));
1440 void MenuDefinition::expandIndicesContext(Buffer const * buf, bool listof)
1445 BufferParams const & params = buf->masterBuffer()->params();
1446 if (!params.use_indices || params.indiceslist().empty())
1449 IndicesList::const_iterator cit = params.indiceslist().begin();
1450 IndicesList::const_iterator end = params.indiceslist().end();
1452 for (int ii = 1; cit != end; ++cit, ++ii) {
1454 InsetCommandParams p(INDEX_PRINT_CODE);
1455 p["type"] = cit->shortcut();
1456 string const data = InsetCommand::params2string(p);
1457 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(cit->index()),
1458 FuncRequest(LFUN_INSET_MODIFY, data)));
1460 docstring const label =
1461 bformat(_("Index Entry (%1$s)"), cit->index());
1462 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1463 FuncRequest(LFUN_INSET_MODIFY,
1464 from_ascii("changetype ") + cit->shortcut())));
1470 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1475 Inset const * inset = bv->cursor().nextInset();
1476 if (!inset || inset->lyxCode() != CITE_CODE) {
1477 add(MenuItem(MenuItem::Command,
1478 qt_("No Citation in Scope!"),
1479 FuncRequest(LFUN_NOACTION)));
1482 InsetCommand const * citinset =
1483 static_cast<InsetCommand const *>(inset);
1485 Buffer const * buf = &bv->buffer();
1486 docstring key = citinset->getParam("key");
1487 // we can only handle one key currently
1488 if (contains(key, ','))
1489 key = qstring_to_ucs4(toqstr(key).split(',')[0]);
1491 vector<CiteStyle> citeStyleList = citeStyles(buf->params().citeEngine());
1492 docstring_list citeStrings =
1493 buf->masterBibInfo().getCiteStrings(key, bv->buffer());
1495 docstring_list::const_iterator cit = citeStrings.begin();
1496 docstring_list::const_iterator end = citeStrings.end();
1498 for (int ii = 1; cit != end; ++cit, ++ii) {
1499 docstring label = *cit;
1501 CiteStyle cst = citeStyleList[ii - 1];
1503 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1504 FuncRequest(LFUN_INSET_MODIFY,
1505 "changetype " + from_utf8(citationStyleToString(cs)))));
1512 /////////////////////////////////////////////////////////////////////
1513 // Menu::Impl definition and implementation
1514 /////////////////////////////////////////////////////////////////////
1518 /// populates the menu or one of its submenu
1519 /// This is used as a recursive function
1520 void populate(QMenu & qMenu, MenuDefinition const & menu);
1522 /// Only needed for top level menus.
1523 MenuDefinition * top_level_menu;
1526 /// the name of this menu
1532 /// Get a MenuDefinition item label from the menu backend
1533 static QString label(MenuItem const & mi)
1535 QString label = mi.label();
1536 label.replace("&", "&&");
1538 QString shortcut = mi.shortcut();
1539 if (!shortcut.isEmpty()) {
1540 int pos = label.indexOf(shortcut);
1542 //label.insert(pos, 1, char_type('&'));
1543 label.replace(pos, 0, "&");
1546 QString const binding = mi.binding();
1547 if (!binding.isEmpty())
1548 label += '\t' + binding;
1553 void Menu::Impl::populate(QMenu & qMenu, MenuDefinition const & menu)
1555 LYXERR(Debug::GUI, "populating menu " << menu.name());
1556 if (menu.size() == 0) {
1557 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
1560 LYXERR(Debug::GUI, " ***** menu entries " << menu.size());
1561 MenuDefinition::const_iterator m = menu.begin();
1562 MenuDefinition::const_iterator end = menu.end();
1563 for (; m != end; ++m) {
1564 if (m->kind() == MenuItem::Separator)
1565 qMenu.addSeparator();
1566 else if (m->kind() == MenuItem::Submenu) {
1567 QMenu * subMenu = qMenu.addMenu(label(*m));
1568 populate(*subMenu, m->submenu());
1569 subMenu->setEnabled(m->status().enabled());
1571 // we have a MenuItem::Command
1572 qMenu.addAction(new Action(view, QIcon(), label(*m),
1573 m->func(), m->tooltip(), &qMenu));
1578 #if defined(Q_WS_WIN) && (QT_VERSION >= 0x040600)
1579 class AlwaysMnemonicStyle : public QProxyStyle {
1581 int styleHint(StyleHint hint, const QStyleOption *opt = 0, const QWidget *widget = 0,
1582 QStyleHintReturn *returnData = 0) const
1584 if (hint == QStyle::SH_UnderlineShortcut)
1586 return QProxyStyle::styleHint(hint, opt, widget, returnData);
1591 /////////////////////////////////////////////////////////////////////
1592 // Menu implementation
1593 /////////////////////////////////////////////////////////////////////
1595 Menu::Menu(GuiView * gv, QString const & name, bool top_level, bool keyboard)
1596 : QMenu(gv), d(new Menu::Impl)
1598 #if defined(Q_WS_WIN) && (QT_VERSION >= 0x040600)
1600 setStyle(new AlwaysMnemonicStyle);
1604 d->top_level_menu = top_level? new MenuDefinition : 0;
1608 if (d->top_level_menu)
1609 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1615 delete d->top_level_menu;
1620 void Menu::updateView()
1622 guiApp->menus().updateMenu(this);
1628 QList<QAction *> items = actions();
1629 for (int i = 0; i != items.size(); ++i) {
1630 // QAction::menu() returns 0 if there's no submenu.
1631 delete items.at(i)->menu();
1637 /////////////////////////////////////////////////////////////////////
1638 // Menus::Impl definition and implementation
1639 /////////////////////////////////////////////////////////////////////
1641 struct Menus::Impl {
1643 bool hasMenu(QString const &) const;
1645 MenuDefinition & getMenu(QString const &);
1647 MenuDefinition const & getMenu(QString const &) const;
1649 /// Expands some special entries of the menu
1650 /** The entries with the following kind are expanded to a
1651 sequence of Command MenuItems: Lastfiles, Documents,
1652 ViewFormats, ExportFormats, UpdateFormats, Branches, Indices
1654 void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1655 BufferView const *) const;
1657 /// Initialize specific MACOS X menubar
1658 void macxMenuBarInit(GuiView * view, QMenuBar * qmb);
1660 /// Mac special menu.
1661 /** This defines a menu whose entries list the FuncRequests
1662 that will be removed by expand() in other menus. This is
1663 used by the Qt/Mac code.
1665 NOTE: Qt does not remove the menu items when clearing a QMenuBar,
1666 such that the items will keep accessing the FuncRequests in
1667 the MenuDefinition. While Menus::Impl might be recreated,
1668 we keep mac_special_menu_ in memory by making it static.
1670 static MenuDefinition mac_special_menu_;
1675 MenuDefinition menubar_;
1677 typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
1679 /// name to menu for \c menu() method.
1684 MenuDefinition Menus::Impl::mac_special_menu_;
1688 Here is what the Qt documentation says about how a menubar is chosen:
1690 1) If the window has a QMenuBar then it is used. 2) If the window
1691 is a modal then its menubar is used. If no menubar is specified
1692 then a default menubar is used (as documented below) 3) If the
1693 window has no parent then the default menubar is used (as
1696 The above 3 steps are applied all the way up the parent window
1697 chain until one of the above are satisifed. If all else fails a
1698 default menubar will be created, the default menubar on Qt/Mac is
1699 an empty menubar, however you can create a different default
1700 menubar by creating a parentless QMenuBar, the first one created
1701 will thus be designated the default menubar, and will be used
1702 whenever a default menubar is needed.
1704 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1705 that this menubar will be used also when one of LyX' dialogs has
1708 void Menus::Impl::macxMenuBarInit(GuiView * view, QMenuBar * qmb)
1710 /* Since Qt 4.2, the qt/mac menu code has special code for
1711 specifying the role of a menu entry. However, it does not
1712 work very well with our scheme of creating menus on demand,
1713 and therefore we need to put these entries in a special
1714 invisible menu. (JMarc)
1717 /* The entries of our special mac menu. If we add support for
1718 * special entries in Menus, we could imagine something
1720 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
1721 * and therefore avoid hardcoding. I am not sure it is worth
1722 * the hassle, though. (JMarc)
1724 struct MacMenuEntry {
1728 QAction::MenuRole role;
1731 MacMenuEntry entries[] = {
1732 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1733 QAction::AboutRole},
1734 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1735 QAction::PreferencesRole},
1736 {LFUN_RECONFIGURE, "", "Reconfigure",
1737 QAction::ApplicationSpecificRole},
1738 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1740 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1741 const bool first_call = mac_special_menu_.size() == 0;
1743 // the special menu for Menus. Fill it up only once.
1745 for (size_t i = 0 ; i < num_entries ; ++i) {
1746 FuncRequest const func(entries[i].action,
1747 from_utf8(entries[i].arg));
1748 mac_special_menu_.add(MenuItem(MenuItem::Command,
1749 entries[i].label, func));
1753 // add the entries to a QMenu that will eventually be empty
1754 // and therefore invisible.
1755 QMenu * qMenu = qmb->addMenu("special");
1756 MenuDefinition::const_iterator cit = mac_special_menu_.begin();
1757 MenuDefinition::const_iterator end = mac_special_menu_.end();
1758 for (size_t i = 0 ; cit != end ; ++cit, ++i) {
1759 #if defined(QT_MAC_USE_COCOA) && (QT_MAC_USE_COCOA > 0)
1760 if (first_call || entries[i].role != QAction::ApplicationSpecificRole) {
1761 Action * action = new Action(view, QIcon(), cit->label(),
1762 cit->func(), QString(), qMenu);
1763 action->setMenuRole(entries[i].role);
1764 qMenu->addAction(action);
1767 Action * action = new Action(view, QIcon(), cit->label(),
1768 cit->func(), QString(), qMenu);
1769 action->setMenuRole(entries[i].role);
1770 qMenu->addAction(action);
1776 void Menus::Impl::expand(MenuDefinition const & frommenu,
1777 MenuDefinition & tomenu, BufferView const * bv) const
1779 if (!tomenu.empty())
1782 for (MenuDefinition::const_iterator cit = frommenu.begin();
1783 cit != frommenu.end() ; ++cit) {
1784 Buffer const * buf = bv ? &bv->buffer() : 0;
1785 switch (cit->kind()) {
1786 case MenuItem::Lastfiles:
1787 tomenu.expandLastfiles();
1790 case MenuItem::Documents:
1791 tomenu.expandDocuments();
1794 case MenuItem::Bookmarks:
1795 tomenu.expandBookmarks();
1798 case MenuItem::ImportFormats:
1799 case MenuItem::ViewFormats:
1800 case MenuItem::UpdateFormats:
1801 case MenuItem::ExportFormats:
1802 tomenu.expandFormats(cit->kind(), buf);
1805 case MenuItem::CharStyles:
1806 tomenu.expandFlexInsert(buf, InsetLayout::CHARSTYLE);
1809 case MenuItem::Custom:
1810 tomenu.expandFlexInsert(buf, InsetLayout::CUSTOM);
1813 case MenuItem::Elements:
1814 tomenu.expandFlexInsert(buf, InsetLayout::ELEMENT);
1817 case MenuItem::FloatListInsert:
1818 tomenu.expandFloatListInsert(buf);
1821 case MenuItem::FloatInsert:
1822 tomenu.expandFloatInsert(buf);
1825 case MenuItem::PasteRecent:
1826 tomenu.expandPasteRecent(buf);
1829 case MenuItem::Toolbars:
1830 tomenu.expandToolbars();
1833 case MenuItem::Branches:
1834 tomenu.expandBranches(buf);
1837 case MenuItem::Indices:
1838 tomenu.expandIndices(buf);
1841 case MenuItem::IndicesContext:
1842 tomenu.expandIndicesContext(buf);
1845 case MenuItem::IndicesLists:
1846 tomenu.expandIndices(buf, true);
1849 case MenuItem::IndicesListsContext:
1850 tomenu.expandIndicesContext(buf, true);
1853 case MenuItem::CiteStyles:
1854 tomenu.expandCiteStyles(bv);
1858 tomenu.expandToc(buf);
1861 case MenuItem::GraphicsGroups:
1862 tomenu.expandGraphicsGroups(bv);
1865 case MenuItem::SpellingSuggestions:
1866 tomenu.expandSpellingSuggestions(bv);
1869 case MenuItem::LanguageSelector:
1870 tomenu.expandLanguageSelector(buf);
1873 case MenuItem::Submenu: {
1874 MenuItem item(*cit);
1875 item.setSubmenu(MenuDefinition(cit->submenuname()));
1876 expand(getMenu(cit->submenuname()), item.submenu(), bv);
1877 tomenu.addWithStatusCheck(item);
1881 case MenuItem::Info:
1882 case MenuItem::Help:
1883 case MenuItem::Separator:
1884 tomenu.addWithStatusCheck(*cit);
1887 case MenuItem::Command:
1888 if (!mac_special_menu_.hasFunc(cit->func()))
1889 tomenu.addWithStatusCheck(*cit);
1893 // we do not want the menu to end with a separator
1894 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
1895 tomenu.items_.pop_back();
1897 // Check whether the shortcuts are unique
1898 tomenu.checkShortcuts();
1902 bool Menus::Impl::hasMenu(QString const & name) const
1904 return find_if(menulist_.begin(), menulist_.end(),
1905 MenuNamesEqual(name)) != menulist_.end();
1909 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
1911 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
1912 MenuNamesEqual(name));
1913 if (cit == menulist_.end())
1914 LYXERR0("No submenu named " << name);
1915 LASSERT(cit != menulist_.end(), /**/);
1920 MenuDefinition & Menus::Impl::getMenu(QString const & name)
1922 iterator it = find_if(menulist_.begin(), menulist_.end(),
1923 MenuNamesEqual(name));
1924 if (it == menulist_.end())
1925 LYXERR0("No submenu named " << name);
1926 LASSERT(it != menulist_.end(), /**/);
1931 /////////////////////////////////////////////////////////////////////
1935 /////////////////////////////////////////////////////////////////////
1937 Menus::Menus() : d(new Impl) {}
1953 void Menus::read(Lexer & lex)
1961 LexerKeyword menutags[] = {
1962 { "end", md_endmenuset },
1963 { "menu", md_menu },
1964 { "menubar", md_menubar }
1967 // consistency check
1968 if (compare_ascii_no_case(lex.getString(), "menuset"))
1969 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
1971 lex.pushTable(menutags);
1972 lex.setContext("Menus::read");
1976 while (lex.isOK() && !quit) {
1977 switch (lex.lex()) {
1979 d->menubar_.read(lex);
1983 QString const name = toqstr(lex.getDocString());
1984 if (d->hasMenu(name))
1985 d->getMenu(name).read(lex);
1987 MenuDefinition menu(name);
1989 d->menulist_.push_back(menu);
1997 lex.printError("Unknown menu tag");
2005 bool Menus::searchMenu(FuncRequest const & func,
2006 docstring_list & names) const
2008 MenuDefinition menu;
2009 d->expand(d->menubar_, menu, 0);
2010 return menu.searchMenu(func, names);
2014 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
2018 // setup special mac specific menu items, but only do this
2019 // the first time a QMenuBar is created. Otherwise Qt will
2020 // create duplicate items in the application menu. It seems
2021 // that Qt does not remove them when the QMenubar is cleared.
2022 LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
2023 d->macxMenuBarInit(view, qmb);
2026 // Clear all menubar contents before filling it.
2030 LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
2032 if (d->menubar_.size() == 0) {
2033 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
2034 << d->menubar_.name());
2037 LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
2039 MenuDefinition menu;
2040 BufferView * bv = 0;
2042 bv = view->currentBufferView();
2043 d->expand(d->menubar_, menu, bv);
2045 MenuDefinition::const_iterator m = menu.begin();
2046 MenuDefinition::const_iterator end = menu.end();
2048 for (; m != end; ++m) {
2050 if (m->kind() != MenuItem::Submenu) {
2051 LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
2055 LYXERR(Debug::GUI, "menu bar item " << m->label()
2056 << " is a submenu named " << m->submenuname());
2058 QString name = m->submenuname();
2059 if (!d->hasMenu(name)) {
2060 LYXERR(Debug::GUI, "\tERROR: " << name
2061 << " submenu has no menu!");
2065 Menu * menu = new Menu(view, m->submenuname(), true);
2066 menu->setTitle(label(*m));
2069 d->name_map_[view][name] = menu;
2074 void Menus::updateMenu(Menu * qmenu)
2076 LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
2079 if (qmenu->d->name.isEmpty())
2082 docstring identifier = qstring_to_ucs4(qmenu->d->name);
2083 MenuDefinition fromLyxMenu(qmenu->d->name);
2084 while (!identifier.empty()) {
2085 docstring menu_name;
2086 identifier = split(identifier, menu_name, ';');
2088 if (!d->hasMenu(toqstr(menu_name))) {
2089 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
2094 MenuDefinition cat_menu = d->getMenu(toqstr(menu_name));
2095 //FIXME: 50 is a wild guess. We should take into account here
2096 //the expansion of menu items, disabled optional items etc.
2097 bool const in_sub_menu = fromLyxMenu.size() > 0
2098 && fromLyxMenu.size() + cat_menu.size() > 50 ;
2100 fromLyxMenu.catSub(menu_name);
2102 fromLyxMenu.cat(cat_menu);
2103 fromLyxMenu.add(MenuItem(MenuItem::Separator));
2106 if (fromLyxMenu.empty()) {
2107 qmenu->addAction(qt_("No Action Defined!"));
2111 BufferView * bv = 0;
2113 bv = qmenu->d->view->currentBufferView();
2114 d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
2115 qmenu->d->populate(*qmenu, *qmenu->d->top_level_menu);
2119 Menu * Menus::menu(QString const & name, GuiView & view, bool keyboard)
2121 LYXERR(Debug::GUI, "Context menu requested: " << name);
2122 Menu * menu = d->name_map_[&view].value(name, 0);
2123 if (!menu && !name.startsWith("context-")) {
2124 LYXERR0("requested context menu not found: " << name);
2128 menu = new Menu(&view, name, true, keyboard);
2129 d->name_map_[&view][name] = menu;
2133 } // namespace frontend
2136 #include "moc_Menus.cpp"