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 "qt_helpers.h"
26 #include "BiblioInfo.h"
27 #include "BranchList.h"
29 #include "BufferList.h"
30 #include "BufferParams.h"
31 #include "BufferView.h"
32 #include "Converter.h"
33 #include "CutAndPaste.h"
35 #include "FloatList.h"
37 #include "FuncRequest.h"
38 #include "FuncStatus.h"
41 #include "LyXAction.h"
42 #include "LyX.h" // for lastfiles
44 #include "Paragraph.h"
45 #include "ParIterator.h"
47 #include "TextClass.h"
48 #include "TocBackend.h"
51 #include "insets/Inset.h"
52 #include "insets/InsetCitation.h"
53 #include "insets/InsetGraphics.h"
55 #include "support/lassert.h"
56 #include "support/convert.h"
57 #include "support/debug.h"
58 #include "support/docstring_list.h"
59 #include "support/filetools.h"
60 #include "support/gettext.h"
61 #include "support/lstrings.h"
69 #include <boost/shared_ptr.hpp>
75 using namespace lyx::support;
83 // MacOSX specific stuff is at the end.
90 /// The type of elements that can be in a menu
98 /** This type of item explains why something is unavailable. If this
99 menuitem is in a submenu, the submenu is enabled to make sure the
100 user sees the information. */
102 /** This type of item merely shows that there might be a list or
103 something alike at this position, but the list is still empty.
104 If this item is in a submenu, the submenu will not always be
107 /** This is the list of last opened file,
108 typically for the File menu. */
110 /** This is the list of opened Documents,
111 typically for the Documents menu. */
113 /** This is the bookmarks */
117 /** This is a list of viewable formats
118 typically for the File->View menu. */
120 /** This is a list of updatable formats
121 typically for the File->Update menu. */
123 /** This is a list of exportable formats
124 typically for the File->Export menu. */
126 /** This is a list of importable formats
127 typically for the File->Export menu. */
129 /** This is the list of elements available
130 * for insertion into document. */
132 /** This is the list of user-configurable
133 insets to insert into document */
135 /** This is the list of XML elements to
136 insert into the document */
138 /** This is the list of floats that we can
139 insert a list for. */
141 /** This is the list of floats that we can
144 /** This is the list of selections that can
149 /** Available branches in document */
151 /** Available citation styles for a given citation */
153 /** Available graphics groups */
157 explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
160 QString const & label,
161 QString const & submenu = QString(),
162 bool optional = false)
163 : kind_(kind), label_(label), submenuname_(submenu), optional_(optional)
165 LASSERT(kind == Submenu || kind == Help || kind == Info, /**/);
169 QString const & label,
170 FuncRequest const & func,
171 bool optional = false)
172 : kind_(kind), label_(label), func_(func), optional_(optional)
174 func_.origin = FuncRequest::MENU;
177 // boost::shared_ptr<MenuDefinition> needs this apprently...
180 /// The label of a given menuitem
181 QString label() const { return label_.split('|')[0]; }
183 /// The keyboard shortcut (usually underlined in the entry)
184 QString shortcut() const
186 return label_.contains('|') ? label_.split('|')[1] : QString();
188 /// The complete label, with label and shortcut separated by a '|'
189 QString fulllabel() const { return label_;}
190 /// The kind of entry
191 Kind kind() const { return kind_; }
192 /// the action (if relevant)
193 FuncRequest const & func() const { return func_; }
194 /// returns true if the entry should be ommited when disabled
195 bool optional() const { return optional_; }
196 /// returns the status of the lfun associated with this entry
197 FuncStatus const & status() const { return status_; }
198 /// returns the status of the lfun associated with this entry
199 FuncStatus & status() { return status_; }
200 /// returns the status of the lfun associated with this entry
201 void status(FuncStatus const & status) { status_ = status; }
203 ///returns the binding associated to this action.
204 QString binding() const
206 if (kind_ != Command)
208 // Get the keys bound to this action, but keep only the
210 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
212 return toqstr(bindings.begin()->print(KeySequence::ForGui));
214 LYXERR(Debug::KBMAP, "No binding for "
215 << lyxaction.getActionName(func_.action)
216 << '(' << func_.argument() << ')');
220 /// the description of the submenu (if relevant)
221 QString const & submenuname() const { return submenuname_; }
222 /// set the description of the submenu
223 void submenuname(QString const & name) { submenuname_ = name; }
225 bool hasSubmenu() const { return !submenu_.isEmpty(); }
227 MenuDefinition const & submenu() const { return submenu_.at(0); }
228 MenuDefinition & submenu() { return submenu_[0]; }
230 void setSubmenu(MenuDefinition const & menu)
233 submenu_.append(menu);
244 QString submenuname_;
249 /// contains 0 or 1 item.
250 QList<MenuDefinition> submenu_;
254 class MenuDefinition {
257 typedef std::vector<MenuItem> ItemList;
259 typedef ItemList::const_iterator const_iterator;
261 explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
266 QString const & name() const { return name_; }
268 bool empty() const { return items_.empty(); }
269 /// Clear the menu content.
270 void clear() { items_.clear(); }
272 size_t size() const { return items_.size(); }
274 MenuItem const & operator[](size_t) const;
276 const_iterator begin() const { return items_.begin(); }
278 const_iterator end() const { return items_.end(); }
280 // search for func in this menu iteratively, and put menu
282 bool searchMenu(FuncRequest const & func, docstring_list & names)
285 bool hasFunc(FuncRequest const &) const;
286 /// Add the menu item unconditionally
287 void add(MenuItem const & item) { items_.push_back(item); }
288 /// Checks the associated FuncRequest status before adding the
290 void addWithStatusCheck(MenuItem const &);
291 // Check whether the menu shortcuts are unique
292 void checkShortcuts() const;
294 void expandLastfiles();
295 void expandDocuments();
296 void expandBookmarks();
297 void expandFormats(MenuItem::Kind kind, Buffer const * buf);
298 void expandFloatListInsert(Buffer const * buf);
299 void expandFloatInsert(Buffer const * buf);
300 void expandFlexInsert(Buffer const * buf, InsetLayout::InsetLyXType type);
301 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth);
302 void expandToc(Buffer const * buf);
303 void expandPasteRecent(Buffer const * buf);
304 void expandToolbars();
305 void expandBranches(Buffer const * buf);
306 void expandCiteStyles(BufferView const *);
307 void expandGraphicsGroups(BufferView const *);
315 /// Helper for std::find_if
319 MenuNamesEqual(QString const & name) : name_(name) {}
320 bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
327 typedef std::vector<MenuDefinition> MenuList;
329 typedef MenuList::const_iterator const_iterator;
331 typedef MenuList::iterator iterator;
333 /////////////////////////////////////////////////////////////////////
334 // MenuDefinition implementation
335 /////////////////////////////////////////////////////////////////////
337 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
341 case MenuItem::Command: {
342 FuncStatus status = lyx::getStatus(i.func());
343 if (status.unknown() || (!status.enabled() && i.optional()))
346 items_.back().status(status);
350 case MenuItem::Submenu: {
351 bool enabled = false;
352 if (i.hasSubmenu()) {
353 for (const_iterator cit = i.submenu().begin();
354 cit != i.submenu().end(); ++cit) {
355 // Only these kind of items affect the status of the submenu
356 if ((cit->kind() == MenuItem::Command
357 || cit->kind() == MenuItem::Submenu
358 || cit->kind() == MenuItem::Help)
359 && cit->status().enabled()) {
365 if (enabled || !i.optional()) {
367 items_.back().status().setEnabled(enabled);
372 case MenuItem::Separator:
373 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
383 void MenuDefinition::read(Lexer & lex)
412 LexerKeyword menutags[] = {
413 { "bookmarks", md_bookmarks },
414 { "branches", md_branches },
415 { "charstyles", md_charstyles },
416 { "citestyles", md_citestyles },
417 { "custom", md_custom },
418 { "documents", md_documents },
419 { "elements", md_elements },
420 { "end", md_endmenu },
421 { "exportformats", md_exportformats },
422 { "floatinsert", md_floatinsert },
423 { "floatlistinsert", md_floatlistinsert },
424 { "graphicsgroups", md_graphicsgroups },
425 { "importformats", md_importformats },
427 { "lastfiles", md_lastfiles },
428 { "optitem", md_optitem },
429 { "optsubmenu", md_optsubmenu },
430 { "pasterecent", md_pasterecent },
431 { "separator", md_separator },
432 { "submenu", md_submenu },
434 { "toolbars", md_toolbars },
435 { "updateformats", md_updateformats },
436 { "viewformats", md_viewformats }
439 lex.pushTable(menutags);
440 lex.setContext("MenuDefinition::read: ");
443 bool optional = false;
445 while (lex.isOK() && !quit) {
449 // fallback to md_item
452 docstring const name = translateIfPossible(lex.getDocString());
454 string const command = lex.getString();
455 FuncRequest func = lyxaction.lookupFunc(command);
456 add(MenuItem(MenuItem::Command, toqstr(name), func, optional));
462 add(MenuItem(MenuItem::Separator));
466 add(MenuItem(MenuItem::Lastfiles));
470 add(MenuItem(MenuItem::CharStyles));
474 add(MenuItem(MenuItem::Custom));
478 add(MenuItem(MenuItem::Elements));
482 add(MenuItem(MenuItem::Documents));
486 add(MenuItem(MenuItem::Bookmarks));
490 add(MenuItem(MenuItem::Toc));
494 add(MenuItem(MenuItem::ViewFormats));
497 case md_updateformats:
498 add(MenuItem(MenuItem::UpdateFormats));
501 case md_exportformats:
502 add(MenuItem(MenuItem::ExportFormats));
505 case md_importformats:
506 add(MenuItem(MenuItem::ImportFormats));
509 case md_floatlistinsert:
510 add(MenuItem(MenuItem::FloatListInsert));
514 add(MenuItem(MenuItem::FloatInsert));
518 add(MenuItem(MenuItem::PasteRecent));
522 add(MenuItem(MenuItem::Toolbars));
526 add(MenuItem(MenuItem::Branches));
530 add(MenuItem(MenuItem::CiteStyles));
533 case md_graphicsgroups:
534 add(MenuItem(MenuItem::GraphicsGroups));
539 // fallback to md_submenu
542 docstring const mlabel = translateIfPossible(lex.getDocString());
544 docstring const mname = lex.getDocString();
545 add(MenuItem(MenuItem::Submenu,
546 toqstr(mlabel), toqstr(mname), optional));
556 lex.printError("Unknown menu tag");
564 MenuItem const & MenuDefinition::operator[](size_type i) const
570 bool MenuDefinition::hasFunc(FuncRequest const & func) const
572 for (const_iterator it = begin(), et = end(); it != et; ++it)
573 if (it->func() == func)
579 void MenuDefinition::checkShortcuts() const
581 // This is a quadratic algorithm, but we do not care because
582 // menus are short enough
583 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
584 QString shortcut = it1->shortcut();
585 if (shortcut.isEmpty())
587 if (!it1->label().contains(shortcut))
588 LYXERR0("Menu warning: menu entry \""
590 << "\" does not contain shortcut `"
591 << shortcut << "'.");
592 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
593 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
594 LYXERR0("Menu warning: menu entries "
595 << '"' << it1->fulllabel()
596 << "\" and \"" << it2->fulllabel()
597 << "\" share the same shortcut.");
604 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
606 const_iterator m = begin();
607 const_iterator m_end = end();
608 for (; m != m_end; ++m) {
609 if (m->kind() == MenuItem::Command && m->func() == func) {
610 names.push_back(qstring_to_ucs4(m->label()));
613 if (m->kind() == MenuItem::Submenu) {
614 names.push_back(qstring_to_ucs4(m->label()));
615 if (!m->hasSubmenu()) {
616 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
617 << m->label() << " name=" << m->submenuname());
621 if (m->submenu().searchMenu(func, names))
630 bool compareFormat(Format const * p1, Format const * p2)
636 QString limitStringLength(docstring const & str)
638 size_t const max_item_length = 45;
640 if (str.size() > max_item_length)
641 return toqstr(str.substr(0, max_item_length - 3) + "...");
647 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
652 graphics::getGraphicsGroups(bv->buffer(), grp);
656 set<string>::const_iterator it = grp.begin();
657 set<string>::const_iterator end = grp.end();
658 add(MenuItem(MenuItem::Command, qt_("No Group"),
659 FuncRequest(LFUN_SET_GRAPHICS_GROUP)));
660 for (; it != end; it++) {
661 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it),
662 FuncRequest(LFUN_SET_GRAPHICS_GROUP, *it)));
666 void MenuDefinition::expandLastfiles()
668 LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
669 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
673 for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
674 string const file = lfit->absFilename();
675 QString const label = QString("%1. %2|%3").arg(ii)
676 .arg(toqstr(makeDisplayPath(file, 30))).arg(ii);
677 add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
682 void MenuDefinition::expandDocuments()
684 MenuItem item(MenuItem::Submenu, qt_("Invisible"));
685 item.setSubmenu(MenuDefinition(qt_("Invisible")));
687 Buffer * first = theBufferList().first();
693 // We cannot use a for loop as the buffer list cycles.
695 QString label = toqstr(b->fileName().displayName(20));
698 bool const shown = guiApp->currentView()->workArea(*b);
699 int ii = shown ? vis : invis;
701 label = QString::number(ii) + ". " + label + '|' + QString::number(ii);
703 add(MenuItem(MenuItem::Command, label,
704 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
707 item.submenu().add(MenuItem(MenuItem::Command, label,
708 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
711 b = theBufferList().next(b);
712 } while (b != first);
713 if (!item.submenu().empty())
716 add(MenuItem(MenuItem::Info, qt_("<No documents open>")));
720 void MenuDefinition::expandBookmarks()
722 lyx::BookmarksSection const & bm = theSession().bookmarks();
725 for (size_t i = 1; i <= bm.size(); ++i) {
727 string const file = bm.bookmark(i).filename.absFilename();
728 QString const label = QString("%1. %2|%3").arg(i)
729 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
730 add(MenuItem(MenuItem::Command, label,
731 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
736 add(MenuItem(MenuItem::Info, qt_("<No bookmarks saved yet>")));
740 void MenuDefinition::expandFormats(MenuItem::Kind kind, Buffer const * buf)
742 if (!buf && kind != MenuItem::ImportFormats)
745 typedef vector<Format const *> Formats;
750 case MenuItem::ImportFormats:
751 formats = theConverters().importableFormats();
752 action = LFUN_BUFFER_IMPORT;
754 case MenuItem::ViewFormats:
755 formats = buf->exportableFormats(true);
756 action = LFUN_BUFFER_VIEW;
758 case MenuItem::UpdateFormats:
759 formats = buf->exportableFormats(true);
760 action = LFUN_BUFFER_UPDATE;
763 formats = buf->exportableFormats(false);
764 action = LFUN_BUFFER_EXPORT;
766 sort(formats.begin(), formats.end(), &compareFormat);
768 Formats::const_iterator fit = formats.begin();
769 Formats::const_iterator end = formats.end();
770 for (; fit != end ; ++fit) {
774 docstring lab = from_utf8((*fit)->prettyname());
775 docstring scut = from_utf8((*fit)->shortcut());
776 docstring const tmplab = lab;
779 lab += char_type('|') + scut;
780 docstring lab_i18n = translateIfPossible(lab);
781 bool const untranslated = (lab == lab_i18n);
782 QString const shortcut = toqstr(split(lab_i18n, lab, '|'));
783 QString label = toqstr(lab);
785 // this might happen if the shortcut
786 // has been redefined
787 label = toqstr(translateIfPossible(tmplab));
790 case MenuItem::ImportFormats:
793 case MenuItem::ViewFormats:
794 case MenuItem::ExportFormats:
795 case MenuItem::UpdateFormats:
796 if (!(*fit)->documentFormat())
800 LASSERT(false, /**/);
803 if (!shortcut.isEmpty())
804 label += '|' + shortcut;
807 addWithStatusCheck(MenuItem(MenuItem::Command, label,
808 FuncRequest(action, (*fit)->name())));
810 add(MenuItem(MenuItem::Command, label,
811 FuncRequest(action, (*fit)->name())));
816 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
821 FloatList const & floats = buf->params().documentClass().floats();
822 FloatList::const_iterator cit = floats.begin();
823 FloatList::const_iterator end = floats.end();
824 for (; cit != end; ++cit) {
825 addWithStatusCheck(MenuItem(MenuItem::Command,
826 qt_(cit->second.listName()),
827 FuncRequest(LFUN_FLOAT_LIST_INSERT,
828 cit->second.type())));
833 void MenuDefinition::expandFloatInsert(Buffer const * buf)
838 FloatList const & floats = buf->params().documentClass().floats();
839 FloatList::const_iterator cit = floats.begin();
840 FloatList::const_iterator end = floats.end();
841 for (; cit != end; ++cit) {
843 QString const label = qt_(cit->second.name());
844 addWithStatusCheck(MenuItem(MenuItem::Command, label,
845 FuncRequest(LFUN_FLOAT_INSERT,
846 cit->second.type())));
851 void MenuDefinition::expandFlexInsert(
852 Buffer const * buf, InsetLayout::InsetLyXType type)
857 TextClass::InsetLayouts const & insetLayouts =
858 buf->params().documentClass().insetLayouts();
859 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
860 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
861 for (; cit != end; ++cit) {
862 if (cit->second.lyxtype() == type) {
863 docstring const label = cit->first;
864 addWithStatusCheck(MenuItem(MenuItem::Command,
865 toqstr(translateIfPossible(label)),
866 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(label))));
869 // FIXME This is a little clunky.
870 if (items_.empty() && type == InsetLayout::CUSTOM)
871 add(MenuItem(MenuItem::Help, qt_("No custom insets defined!")));
875 size_t const max_number_of_items = 25;
877 void MenuDefinition::expandToc2(Toc const & toc_list,
878 size_t from, size_t to, int depth)
880 int shortcut_count = 0;
882 // check whether depth is smaller than the smallest depth in toc.
883 int min_depth = 1000;
884 for (size_t i = from; i < to; ++i)
885 min_depth = min(min_depth, toc_list[i].depth());
886 if (min_depth > depth)
889 if (to - from <= max_number_of_items) {
890 for (size_t i = from; i < to; ++i) {
891 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
892 label += limitStringLength(toc_list[i].str());
893 if (toc_list[i].depth() == depth
894 && shortcut_count < 9) {
895 if (label.contains(QString::number(shortcut_count + 1)))
896 label += '|' + QString::number(++shortcut_count);
898 add(MenuItem(MenuItem::Command, label,
899 FuncRequest(toc_list[i].action())));
904 size_t new_pos = pos + 1;
905 while (new_pos < to && toc_list[new_pos].depth() > depth)
908 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
909 label += limitStringLength(toc_list[pos].str());
910 if (toc_list[pos].depth() == depth &&
911 shortcut_count < 9) {
912 if (label.contains(QString::number(shortcut_count + 1)))
913 label += '|' + QString::number(++shortcut_count);
915 if (new_pos == pos + 1) {
916 add(MenuItem(MenuItem::Command,
917 label, FuncRequest(toc_list[pos].action())));
920 sub.expandToc2(toc_list, pos, new_pos, depth + 1);
921 MenuItem item(MenuItem::Submenu, label);
922 item.setSubmenu(sub);
931 void MenuDefinition::expandToc(Buffer const * buf)
933 // To make things very cleanly, we would have to pass buf to
934 // all MenuItem constructors and to expandToc2. However, we
935 // know that all the entries in a TOC will be have status_ ==
936 // OK, so we avoid this unnecessary overhead (JMarc)
939 add(MenuItem(MenuItem::Info, qt_("<No document open>")));
943 // Add an entry for the master doc if this is a child doc
944 Buffer const * const master = buf->masterBuffer();
946 ParIterator const pit = par_iterator_begin(master->inset());
947 string const arg = convert<string>(pit->id());
948 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
949 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
952 MenuDefinition other_lists;
954 FloatList const & floatlist = buf->params().documentClass().floats();
955 TocList const & toc_list = buf->tocBackend().tocs();
956 TocList::const_iterator cit = toc_list.begin();
957 TocList::const_iterator end = toc_list.end();
958 for (; cit != end; ++cit) {
960 if (cit->first == "tableofcontents")
963 MenuDefinition submenu;
964 if (cit->second.size() >= 30) {
965 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
966 submenu.add(MenuItem(MenuItem::Command, qt_("Open Navigator..."), f));
968 TocIterator ccit = cit->second.begin();
969 TocIterator eend = cit->second.end();
970 for (; ccit != eend; ++ccit) {
971 submenu.add(MenuItem(MenuItem::Command,
972 limitStringLength(ccit->str()),
973 FuncRequest(ccit->action())));
977 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
978 item.setSubmenu(submenu);
979 if (floatlist.typeExist(cit->first) || cit->first == "child") {
980 // Those two types deserve to be in the main menu.
981 item.setSubmenu(submenu);
984 other_lists.add(item);
986 if (!other_lists.empty()) {
987 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
988 item.setSubmenu(other_lists);
993 cit = toc_list.find("tableofcontents");
995 LYXERR(Debug::GUI, "No table of contents.");
997 if (cit->second.size() > 0 )
998 expandToc2(cit->second, 0, cit->second.size(), 0);
1000 add(MenuItem(MenuItem::Info, qt_("<Empty table of contents>")));
1005 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1007 docstring_list const sel = cap::availableSelections(buf);
1009 docstring_list::const_iterator cit = sel.begin();
1010 docstring_list::const_iterator end = sel.end();
1012 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1013 add(MenuItem(MenuItem::Command, toqstr(*cit),
1014 FuncRequest(LFUN_PASTE, convert<string>(index))));
1019 void MenuDefinition::expandToolbars()
1021 MenuDefinition other_lists;
1022 // extracts the toolbars from the backend
1023 Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1024 Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1025 for (; cit != end; ++cit) {
1026 MenuItem const item(MenuItem::Command, toqstr(cit->gui_name),
1027 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1028 if (guiApp->toolbars().isMainToolbar(cit->name))
1031 other_lists.add(item);
1034 if (!other_lists.empty()) {
1035 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1036 item.setSubmenu(other_lists);
1042 void MenuDefinition::expandBranches(Buffer const * buf)
1047 BufferParams const & params = buf->masterBuffer()->params();
1048 if (params.branchlist().empty()) {
1049 add(MenuItem(MenuItem::Help, qt_("No branches set for document!")));
1053 BranchList::const_iterator cit = params.branchlist().begin();
1054 BranchList::const_iterator end = params.branchlist().end();
1056 for (int ii = 1; cit != end; ++cit, ++ii) {
1057 docstring label = cit->branch();
1059 label = convert<docstring>(ii) + ". " + label
1060 + char_type('|') + convert<docstring>(ii);
1062 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1063 FuncRequest(LFUN_BRANCH_INSERT,
1069 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1074 Inset const * inset = bv->cursor().nextInset();
1075 if (!inset || inset->lyxCode() != CITE_CODE) {
1076 add(MenuItem(MenuItem::Command,
1077 qt_("No Citation in Scope!"),
1078 FuncRequest(LFUN_NOACTION)));
1081 InsetCommand const * citinset =
1082 static_cast<InsetCommand const *>(inset);
1084 Buffer const * buf = &bv->buffer();
1085 docstring key = citinset->getParam("key");
1086 // we can only handle one key currently
1087 if (contains(key, ','))
1088 key = qstring_to_ucs4(toqstr(key).split(',')[0]);
1090 vector<CiteStyle> citeStyleList = citeStyles(buf->params().citeEngine());
1091 docstring_list citeStrings =
1092 buf->masterBibInfo().getCiteStrings(key, bv->buffer());
1094 docstring_list::const_iterator cit = citeStrings.begin();
1095 docstring_list::const_iterator end = citeStrings.end();
1097 for (int ii = 1; cit != end; ++cit, ++ii) {
1098 docstring label = *cit;
1100 CiteStyle cst = citeStyleList[ii - 1];
1102 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1103 FuncRequest(LFUN_NEXT_INSET_MODIFY,
1104 "changetype " + from_utf8(citationStyleToString(cs)))));
1111 /////////////////////////////////////////////////////////////////////
1112 // Menu::Impl definition and implementation
1113 /////////////////////////////////////////////////////////////////////
1117 /// populates the menu or one of its submenu
1118 /// This is used as a recursive function
1119 void populate(QMenu & qMenu, MenuDefinition const & menu);
1121 /// Only needed for top level menus.
1122 MenuDefinition * top_level_menu;
1125 /// the name of this menu
1131 /// Get a MenuDefinition item label from the menu backend
1132 static QString label(MenuItem const & mi)
1134 QString label = mi.label();
1135 label.replace("&", "&&");
1137 QString shortcut = mi.shortcut();
1138 if (!shortcut.isEmpty()) {
1139 int pos = label.indexOf(shortcut);
1141 //label.insert(pos, 1, char_type('&'));
1142 label.replace(pos, 0, "&");
1145 QString const binding = mi.binding();
1146 if (!binding.isEmpty())
1147 label += '\t' + binding;
1152 void Menu::Impl::populate(QMenu & qMenu, MenuDefinition const & menu)
1154 LYXERR(Debug::GUI, "populating menu " << menu.name());
1155 if (menu.size() == 0) {
1156 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
1159 LYXERR(Debug::GUI, " ***** menu entries " << menu.size());
1160 MenuDefinition::const_iterator m = menu.begin();
1161 MenuDefinition::const_iterator end = menu.end();
1162 for (; m != end; ++m) {
1163 if (m->kind() == MenuItem::Separator)
1164 qMenu.addSeparator();
1165 else if (m->kind() == MenuItem::Submenu) {
1166 QMenu * subMenu = qMenu.addMenu(label(*m));
1167 populate(*subMenu, m->submenu());
1168 subMenu->setEnabled(m->status().enabled());
1170 // we have a MenuItem::Command
1171 qMenu.addAction(new Action(view, QIcon(), label(*m),
1172 m->func(), QString(), &qMenu));
1177 /////////////////////////////////////////////////////////////////////
1178 // Menu implementation
1179 /////////////////////////////////////////////////////////////////////
1181 Menu::Menu(GuiView * gv, QString const & name, bool top_level)
1182 : QMenu(gv), d(new Menu::Impl)
1184 d->top_level_menu = top_level? new MenuDefinition : 0;
1188 if (d->top_level_menu)
1189 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1195 delete d->top_level_menu;
1200 void Menu::updateView()
1202 guiApp->menus().updateMenu(this);
1206 /////////////////////////////////////////////////////////////////////
1207 // Menus::Impl definition and implementation
1208 /////////////////////////////////////////////////////////////////////
1210 struct Menus::Impl {
1212 bool hasMenu(QString const &) const;
1214 MenuDefinition & getMenu(QString const &);
1216 MenuDefinition const & getMenu(QString const &) const;
1218 /// Expands some special entries of the menu
1219 /** The entries with the following kind are expanded to a
1220 sequence of Command MenuItems: Lastfiles, Documents,
1221 ViewFormats, ExportFormats, UpdateFormats, Branches
1223 void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1224 BufferView const *) const;
1226 /// Initialize specific MACOS X menubar
1227 void macxMenuBarInit(GuiView * view, QMenuBar * qmb);
1229 /// Mac special menu.
1230 /** This defines a menu whose entries list the FuncRequests
1231 that will be removed by expand() in other menus. This is
1232 used by the Qt/Mac code.
1234 NOTE: Qt does not remove the menu items when clearing a QMenuBar,
1235 such that the items will keep accessing the FuncRequests in
1236 the MenuDefinition. While Menus::Impl might be recreated,
1237 we keep mac_special_menu_ in memory by making it static.
1239 static MenuDefinition mac_special_menu_;
1244 MenuDefinition menubar_;
1246 typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
1248 /// name to menu for \c menu() method.
1253 MenuDefinition Menus::Impl::mac_special_menu_;
1257 Here is what the Qt documentation says about how a menubar is chosen:
1259 1) If the window has a QMenuBar then it is used. 2) If the window
1260 is a modal then its menubar is used. If no menubar is specified
1261 then a default menubar is used (as documented below) 3) If the
1262 window has no parent then the default menubar is used (as
1265 The above 3 steps are applied all the way up the parent window
1266 chain until one of the above are satisifed. If all else fails a
1267 default menubar will be created, the default menubar on Qt/Mac is
1268 an empty menubar, however you can create a different default
1269 menubar by creating a parentless QMenuBar, the first one created
1270 will thus be designated the default menubar, and will be used
1271 whenever a default menubar is needed.
1273 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1274 that this menubar will be used also when one of LyX' dialogs has
1277 void Menus::Impl::macxMenuBarInit(GuiView * view, QMenuBar * qmb)
1279 /* Since Qt 4.2, the qt/mac menu code has special code for
1280 specifying the role of a menu entry. However, it does not
1281 work very well with our scheme of creating menus on demand,
1282 and therefore we need to put these entries in a special
1283 invisible menu. (JMarc)
1286 /* The entries of our special mac menu. If we add support for
1287 * special entries in Menus, we could imagine something
1289 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
1290 * and therefore avoid hardcoding. I am not sure it is worth
1291 * the hassle, though. (JMarc)
1293 struct MacMenuEntry {
1297 QAction::MenuRole role;
1300 MacMenuEntry entries[] = {
1301 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1302 QAction::AboutRole},
1303 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1304 QAction::PreferencesRole},
1305 {LFUN_RECONFIGURE, "", "Reconfigure",
1306 QAction::ApplicationSpecificRole},
1307 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1309 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1311 // the special menu for Menus. Fill it up only once.
1312 if (mac_special_menu_.size() == 0) {
1313 for (size_t i = 0 ; i < num_entries ; ++i) {
1314 FuncRequest const func(entries[i].action,
1315 from_utf8(entries[i].arg));
1316 mac_special_menu_.add(MenuItem(MenuItem::Command,
1317 entries[i].label, func));
1321 // add the entries to a QMenu that will eventually be empty
1322 // and therefore invisible.
1323 QMenu * qMenu = qmb->addMenu("special");
1324 MenuDefinition::const_iterator cit = mac_special_menu_.begin();
1325 MenuDefinition::const_iterator end = mac_special_menu_.end();
1326 for (size_t i = 0 ; cit != end ; ++cit, ++i) {
1327 Action * action = new Action(view, QIcon(), cit->label(),
1328 cit->func(), QString(), qMenu);
1329 action->setMenuRole(entries[i].role);
1330 qMenu->addAction(action);
1335 void Menus::Impl::expand(MenuDefinition const & frommenu,
1336 MenuDefinition & tomenu, BufferView const * bv) const
1338 if (!tomenu.empty())
1341 for (MenuDefinition::const_iterator cit = frommenu.begin();
1342 cit != frommenu.end() ; ++cit) {
1343 Buffer const * buf = bv ? &bv->buffer() : 0;
1344 switch (cit->kind()) {
1345 case MenuItem::Lastfiles:
1346 tomenu.expandLastfiles();
1349 case MenuItem::Documents:
1350 tomenu.expandDocuments();
1353 case MenuItem::Bookmarks:
1354 tomenu.expandBookmarks();
1357 case MenuItem::ImportFormats:
1358 case MenuItem::ViewFormats:
1359 case MenuItem::UpdateFormats:
1360 case MenuItem::ExportFormats:
1361 tomenu.expandFormats(cit->kind(), buf);
1364 case MenuItem::CharStyles:
1365 tomenu.expandFlexInsert(buf, InsetLayout::CHARSTYLE);
1368 case MenuItem::Custom:
1369 tomenu.expandFlexInsert(buf, InsetLayout::CUSTOM);
1372 case MenuItem::Elements:
1373 tomenu.expandFlexInsert(buf, InsetLayout::ELEMENT);
1376 case MenuItem::FloatListInsert:
1377 tomenu.expandFloatListInsert(buf);
1380 case MenuItem::FloatInsert:
1381 tomenu.expandFloatInsert(buf);
1384 case MenuItem::PasteRecent:
1385 tomenu.expandPasteRecent(buf);
1388 case MenuItem::Toolbars:
1389 tomenu.expandToolbars();
1392 case MenuItem::Branches:
1393 tomenu.expandBranches(buf);
1396 case MenuItem::CiteStyles:
1397 tomenu.expandCiteStyles(bv);
1401 tomenu.expandToc(buf);
1404 case MenuItem::GraphicsGroups:
1405 tomenu.expandGraphicsGroups(bv);
1408 case MenuItem::Submenu: {
1409 MenuItem item(*cit);
1410 item.setSubmenu(MenuDefinition(cit->submenuname()));
1411 expand(getMenu(cit->submenuname()), item.submenu(), bv);
1412 tomenu.addWithStatusCheck(item);
1416 case MenuItem::Info:
1417 case MenuItem::Help:
1418 case MenuItem::Separator:
1419 tomenu.addWithStatusCheck(*cit);
1422 case MenuItem::Command:
1423 if (!mac_special_menu_.hasFunc(cit->func()))
1424 tomenu.addWithStatusCheck(*cit);
1428 // we do not want the menu to end with a separator
1429 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
1430 tomenu.items_.pop_back();
1432 // Check whether the shortcuts are unique
1433 tomenu.checkShortcuts();
1437 bool Menus::Impl::hasMenu(QString const & name) const
1439 return find_if(menulist_.begin(), menulist_.end(),
1440 MenuNamesEqual(name)) != menulist_.end();
1444 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
1446 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
1447 MenuNamesEqual(name));
1448 if (cit == menulist_.end())
1449 LYXERR0("No submenu named " << name);
1450 LASSERT(cit != menulist_.end(), /**/);
1455 MenuDefinition & Menus::Impl::getMenu(QString const & name)
1457 iterator it = find_if(menulist_.begin(), menulist_.end(),
1458 MenuNamesEqual(name));
1459 if (it == menulist_.end())
1460 LYXERR0("No submenu named " << name);
1461 LASSERT(it != menulist_.end(), /**/);
1466 /////////////////////////////////////////////////////////////////////
1470 /////////////////////////////////////////////////////////////////////
1472 Menus::Menus() : d(new Impl) {}
1488 void Menus::read(Lexer & lex)
1496 LexerKeyword menutags[] = {
1497 { "end", md_endmenuset },
1498 { "menu", md_menu },
1499 { "menubar", md_menubar }
1502 // consistency check
1503 if (compare_ascii_no_case(lex.getString(), "menuset"))
1504 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
1506 lex.pushTable(menutags);
1507 lex.setContext("Menus::read");
1511 while (lex.isOK() && !quit) {
1512 switch (lex.lex()) {
1514 d->menubar_.read(lex);
1518 QString const name = toqstr(lex.getDocString());
1519 if (d->hasMenu(name))
1520 d->getMenu(name).read(lex);
1522 MenuDefinition menu(name);
1524 d->menulist_.push_back(menu);
1532 lex.printError("Unknown menu tag");
1540 bool Menus::searchMenu(FuncRequest const & func,
1541 docstring_list & names) const
1543 MenuDefinition menu;
1544 d->expand(d->menubar_, menu, 0);
1545 return menu.searchMenu(func, names);
1549 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
1553 // setup special mac specific menu items, but only do this
1554 // the first time a QMenuBar is created. Otherwise Qt will
1555 // create duplicate items in the application menu. It seems
1556 // that Qt does not remove them when the QMenubar is cleared.
1557 LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
1558 d->macxMenuBarInit(view, qmb);
1561 // Clear all menubar contents before filling it.
1565 LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
1567 if (d->menubar_.size() == 0) {
1568 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
1569 << d->menubar_.name());
1572 LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
1574 MenuDefinition menu;
1575 BufferView * bv = 0;
1578 d->expand(d->menubar_, menu, bv);
1580 MenuDefinition::const_iterator m = menu.begin();
1581 MenuDefinition::const_iterator end = menu.end();
1583 for (; m != end; ++m) {
1585 if (m->kind() != MenuItem::Submenu) {
1586 LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
1590 LYXERR(Debug::GUI, "menu bar item " << m->label()
1591 << " is a submenu named " << m->submenuname());
1593 QString name = m->submenuname();
1594 if (!d->hasMenu(name)) {
1595 LYXERR(Debug::GUI, "\tERROR: " << name
1596 << " submenu has no menu!");
1600 Menu * menu = new Menu(view, m->submenuname(), true);
1601 menu->setTitle(label(*m));
1604 d->name_map_[view][name] = menu;
1609 void Menus::updateMenu(Menu * qmenu)
1611 LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
1614 if (qmenu->d->name.isEmpty())
1617 // Here, We make sure that theLyXFunc points to the correct LyXView.
1618 theLyXFunc().setLyXView(qmenu->d->view);
1620 if (!d->hasMenu(qmenu->d->name)) {
1621 qmenu->addAction(qt_("No action defined!"));
1622 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
1627 MenuDefinition const & fromLyxMenu = d->getMenu(qmenu->d->name);
1628 BufferView * bv = 0;
1630 bv = qmenu->d->view->view();
1631 d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
1632 qmenu->d->populate(*qmenu, *qmenu->d->top_level_menu);
1636 Menu * Menus::menu(QString const & name, GuiView & view)
1638 LYXERR(Debug::GUI, "Context menu requested: " << name);
1639 Menu * menu = d->name_map_[&view].value(name, 0);
1640 if (!menu && !name.startsWith("context-")) {
1641 LYXERR0("requested context menu not found: " << name);
1645 menu = new Menu(&view, name, true);
1646 d->name_map_[&view][name] = menu;
1650 } // namespace frontend
1653 #include "moc_Menus.cpp"