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::UpdateFormats:
795 if ((*fit)->name() == buf->getDefaultOutputFormat())
797 case MenuItem::ExportFormats:
798 if (!(*fit)->documentFormat())
802 LASSERT(false, /**/);
805 if (!shortcut.isEmpty())
806 label += '|' + shortcut;
809 addWithStatusCheck(MenuItem(MenuItem::Command, label,
810 FuncRequest(action, (*fit)->name())));
812 add(MenuItem(MenuItem::Command, label,
813 FuncRequest(action, (*fit)->name())));
818 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
823 FloatList const & floats = buf->params().documentClass().floats();
824 FloatList::const_iterator cit = floats.begin();
825 FloatList::const_iterator end = floats.end();
826 for (; cit != end; ++cit) {
827 addWithStatusCheck(MenuItem(MenuItem::Command,
828 qt_(cit->second.listName()),
829 FuncRequest(LFUN_FLOAT_LIST_INSERT,
830 cit->second.type())));
835 void MenuDefinition::expandFloatInsert(Buffer const * buf)
840 FloatList const & floats = buf->params().documentClass().floats();
841 FloatList::const_iterator cit = floats.begin();
842 FloatList::const_iterator end = floats.end();
843 for (; cit != end; ++cit) {
845 QString const label = qt_(cit->second.name());
846 addWithStatusCheck(MenuItem(MenuItem::Command, label,
847 FuncRequest(LFUN_FLOAT_INSERT,
848 cit->second.type())));
853 void MenuDefinition::expandFlexInsert(
854 Buffer const * buf, InsetLayout::InsetLyXType type)
859 TextClass::InsetLayouts const & insetLayouts =
860 buf->params().documentClass().insetLayouts();
861 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
862 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
863 for (; cit != end; ++cit) {
864 if (cit->second.lyxtype() == type) {
865 docstring const label = cit->first;
866 addWithStatusCheck(MenuItem(MenuItem::Command,
867 toqstr(translateIfPossible(label)),
868 FuncRequest(LFUN_FLEX_INSERT, Lexer::quoteString(label))));
871 // FIXME This is a little clunky.
872 if (items_.empty() && type == InsetLayout::CUSTOM)
873 add(MenuItem(MenuItem::Help, qt_("No custom insets defined!")));
877 size_t const max_number_of_items = 25;
879 void MenuDefinition::expandToc2(Toc const & toc_list,
880 size_t from, size_t to, int depth)
882 int shortcut_count = 0;
884 // check whether depth is smaller than the smallest depth in toc.
885 int min_depth = 1000;
886 for (size_t i = from; i < to; ++i)
887 min_depth = min(min_depth, toc_list[i].depth());
888 if (min_depth > depth)
891 if (to - from <= max_number_of_items) {
892 for (size_t i = from; i < to; ++i) {
893 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
894 label += limitStringLength(toc_list[i].str());
895 if (toc_list[i].depth() == depth
896 && shortcut_count < 9) {
897 if (label.contains(QString::number(shortcut_count + 1)))
898 label += '|' + QString::number(++shortcut_count);
900 add(MenuItem(MenuItem::Command, label,
901 FuncRequest(toc_list[i].action())));
906 size_t new_pos = pos + 1;
907 while (new_pos < to && toc_list[new_pos].depth() > depth)
910 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
911 label += limitStringLength(toc_list[pos].str());
912 if (toc_list[pos].depth() == depth &&
913 shortcut_count < 9) {
914 if (label.contains(QString::number(shortcut_count + 1)))
915 label += '|' + QString::number(++shortcut_count);
917 if (new_pos == pos + 1) {
918 add(MenuItem(MenuItem::Command,
919 label, FuncRequest(toc_list[pos].action())));
922 sub.expandToc2(toc_list, pos, new_pos, depth + 1);
923 MenuItem item(MenuItem::Submenu, label);
924 item.setSubmenu(sub);
933 void MenuDefinition::expandToc(Buffer const * buf)
935 // To make things very cleanly, we would have to pass buf to
936 // all MenuItem constructors and to expandToc2. However, we
937 // know that all the entries in a TOC will be have status_ ==
938 // OK, so we avoid this unnecessary overhead (JMarc)
941 add(MenuItem(MenuItem::Info, qt_("<No document open>")));
945 // Add an entry for the master doc if this is a child doc
946 Buffer const * const master = buf->masterBuffer();
948 ParIterator const pit = par_iterator_begin(master->inset());
949 string const arg = convert<string>(pit->id());
950 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
951 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
954 MenuDefinition other_lists;
956 FloatList const & floatlist = buf->params().documentClass().floats();
957 TocList const & toc_list = buf->tocBackend().tocs();
958 TocList::const_iterator cit = toc_list.begin();
959 TocList::const_iterator end = toc_list.end();
960 for (; cit != end; ++cit) {
962 if (cit->first == "tableofcontents")
965 MenuDefinition submenu;
966 if (cit->second.size() >= 30) {
967 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
968 submenu.add(MenuItem(MenuItem::Command, qt_("Open Navigator..."), f));
970 TocIterator ccit = cit->second.begin();
971 TocIterator eend = cit->second.end();
972 for (; ccit != eend; ++ccit) {
973 submenu.add(MenuItem(MenuItem::Command,
974 limitStringLength(ccit->str()),
975 FuncRequest(ccit->action())));
979 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
980 item.setSubmenu(submenu);
981 if (floatlist.typeExist(cit->first) || cit->first == "child") {
982 // Those two types deserve to be in the main menu.
983 item.setSubmenu(submenu);
986 other_lists.add(item);
988 if (!other_lists.empty()) {
989 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
990 item.setSubmenu(other_lists);
995 cit = toc_list.find("tableofcontents");
997 LYXERR(Debug::GUI, "No table of contents.");
999 if (cit->second.size() > 0 )
1000 expandToc2(cit->second, 0, cit->second.size(), 0);
1002 add(MenuItem(MenuItem::Info, qt_("<Empty table of contents>")));
1007 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1009 docstring_list const sel = cap::availableSelections(buf);
1011 docstring_list::const_iterator cit = sel.begin();
1012 docstring_list::const_iterator end = sel.end();
1014 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1015 add(MenuItem(MenuItem::Command, toqstr(*cit),
1016 FuncRequest(LFUN_PASTE, convert<string>(index))));
1021 void MenuDefinition::expandToolbars()
1023 MenuDefinition other_lists;
1024 // extracts the toolbars from the backend
1025 Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1026 Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1027 for (; cit != end; ++cit) {
1028 MenuItem const item(MenuItem::Command, toqstr(cit->gui_name),
1029 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1030 if (guiApp->toolbars().isMainToolbar(cit->name))
1033 other_lists.add(item);
1036 if (!other_lists.empty()) {
1037 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1038 item.setSubmenu(other_lists);
1044 void MenuDefinition::expandBranches(Buffer const * buf)
1049 BufferParams const & master_params = buf->masterBuffer()->params();
1050 BufferParams const & params = buf->params();
1051 if (params.branchlist().empty() && master_params.branchlist().empty() ) {
1052 add(MenuItem(MenuItem::Help, qt_("No branches set for document!")));
1056 BranchList::const_iterator cit = master_params.branchlist().begin();
1057 BranchList::const_iterator end = master_params.branchlist().end();
1059 for (int ii = 1; cit != end; ++cit, ++ii) {
1060 docstring label = cit->branch();
1062 label = convert<docstring>(ii) + ". " + label
1063 + char_type('|') + convert<docstring>(ii);
1065 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1066 FuncRequest(LFUN_BRANCH_INSERT,
1070 if (buf == buf->masterBuffer())
1073 MenuDefinition child_branches;
1075 BranchList::const_iterator ccit = params.branchlist().begin();
1076 BranchList::const_iterator cend = params.branchlist().end();
1078 for (int ii = 1; ccit != cend; ++ccit, ++ii) {
1079 docstring label = ccit->branch();
1081 label = convert<docstring>(ii) + ". " + label
1082 + char_type('|') + convert<docstring>(ii);
1084 child_branches.addWithStatusCheck(MenuItem(MenuItem::Command,
1086 FuncRequest(LFUN_BRANCH_INSERT,
1090 if (!child_branches.empty()) {
1091 MenuItem item(MenuItem::Submenu, qt_("Child Document"));
1092 item.setSubmenu(child_branches);
1098 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1103 Inset const * inset = bv->cursor().nextInset();
1104 if (!inset || inset->lyxCode() != CITE_CODE) {
1105 add(MenuItem(MenuItem::Command,
1106 qt_("No Citation in Scope!"),
1107 FuncRequest(LFUN_NOACTION)));
1110 InsetCommand const * citinset =
1111 static_cast<InsetCommand const *>(inset);
1113 Buffer const * buf = &bv->buffer();
1114 docstring key = citinset->getParam("key");
1115 // we can only handle one key currently
1116 if (contains(key, ','))
1117 key = qstring_to_ucs4(toqstr(key).split(',')[0]);
1119 vector<CiteStyle> citeStyleList = citeStyles(buf->params().citeEngine());
1120 docstring_list citeStrings =
1121 buf->masterBibInfo().getCiteStrings(key, bv->buffer());
1123 docstring_list::const_iterator cit = citeStrings.begin();
1124 docstring_list::const_iterator end = citeStrings.end();
1126 for (int ii = 1; cit != end; ++cit, ++ii) {
1127 docstring label = *cit;
1129 CiteStyle cst = citeStyleList[ii - 1];
1131 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1132 FuncRequest(LFUN_NEXT_INSET_MODIFY,
1133 "changetype " + from_utf8(citationStyleToString(cs)))));
1140 /////////////////////////////////////////////////////////////////////
1141 // Menu::Impl definition and implementation
1142 /////////////////////////////////////////////////////////////////////
1146 /// populates the menu or one of its submenu
1147 /// This is used as a recursive function
1148 void populate(QMenu & qMenu, MenuDefinition const & menu);
1150 /// Only needed for top level menus.
1151 MenuDefinition * top_level_menu;
1154 /// the name of this menu
1160 /// Get a MenuDefinition item label from the menu backend
1161 static QString label(MenuItem const & mi)
1163 QString label = mi.label();
1164 label.replace("&", "&&");
1166 QString shortcut = mi.shortcut();
1167 if (!shortcut.isEmpty()) {
1168 int pos = label.indexOf(shortcut);
1170 //label.insert(pos, 1, char_type('&'));
1171 label.replace(pos, 0, "&");
1174 QString const binding = mi.binding();
1175 if (!binding.isEmpty())
1176 label += '\t' + binding;
1181 void Menu::Impl::populate(QMenu & qMenu, MenuDefinition const & menu)
1183 LYXERR(Debug::GUI, "populating menu " << menu.name());
1184 if (menu.size() == 0) {
1185 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
1188 LYXERR(Debug::GUI, " ***** menu entries " << menu.size());
1189 MenuDefinition::const_iterator m = menu.begin();
1190 MenuDefinition::const_iterator end = menu.end();
1191 for (; m != end; ++m) {
1192 if (m->kind() == MenuItem::Separator)
1193 qMenu.addSeparator();
1194 else if (m->kind() == MenuItem::Submenu) {
1195 QMenu * subMenu = qMenu.addMenu(label(*m));
1196 populate(*subMenu, m->submenu());
1197 subMenu->setEnabled(m->status().enabled());
1199 // we have a MenuItem::Command
1200 qMenu.addAction(new Action(view, QIcon(), label(*m),
1201 m->func(), QString(), &qMenu));
1206 /////////////////////////////////////////////////////////////////////
1207 // Menu implementation
1208 /////////////////////////////////////////////////////////////////////
1210 Menu::Menu(GuiView * gv, QString const & name, bool top_level)
1211 : QMenu(gv), d(new Menu::Impl)
1213 d->top_level_menu = top_level? new MenuDefinition : 0;
1217 if (d->top_level_menu)
1218 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1224 delete d->top_level_menu;
1229 void Menu::updateView()
1231 guiApp->menus().updateMenu(this);
1235 /////////////////////////////////////////////////////////////////////
1236 // Menus::Impl definition and implementation
1237 /////////////////////////////////////////////////////////////////////
1239 struct Menus::Impl {
1241 bool hasMenu(QString const &) const;
1243 MenuDefinition & getMenu(QString const &);
1245 MenuDefinition const & getMenu(QString const &) const;
1247 /// Expands some special entries of the menu
1248 /** The entries with the following kind are expanded to a
1249 sequence of Command MenuItems: Lastfiles, Documents,
1250 ViewFormats, ExportFormats, UpdateFormats, Branches
1252 void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1253 BufferView const *) const;
1255 /// Initialize specific MACOS X menubar
1256 void macxMenuBarInit(GuiView * view, QMenuBar * qmb);
1258 /// Mac special menu.
1259 /** This defines a menu whose entries list the FuncRequests
1260 that will be removed by expand() in other menus. This is
1261 used by the Qt/Mac code.
1263 NOTE: Qt does not remove the menu items when clearing a QMenuBar,
1264 such that the items will keep accessing the FuncRequests in
1265 the MenuDefinition. While Menus::Impl might be recreated,
1266 we keep mac_special_menu_ in memory by making it static.
1268 static MenuDefinition mac_special_menu_;
1273 MenuDefinition menubar_;
1275 typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
1277 /// name to menu for \c menu() method.
1282 MenuDefinition Menus::Impl::mac_special_menu_;
1286 Here is what the Qt documentation says about how a menubar is chosen:
1288 1) If the window has a QMenuBar then it is used. 2) If the window
1289 is a modal then its menubar is used. If no menubar is specified
1290 then a default menubar is used (as documented below) 3) If the
1291 window has no parent then the default menubar is used (as
1294 The above 3 steps are applied all the way up the parent window
1295 chain until one of the above are satisifed. If all else fails a
1296 default menubar will be created, the default menubar on Qt/Mac is
1297 an empty menubar, however you can create a different default
1298 menubar by creating a parentless QMenuBar, the first one created
1299 will thus be designated the default menubar, and will be used
1300 whenever a default menubar is needed.
1302 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1303 that this menubar will be used also when one of LyX' dialogs has
1306 void Menus::Impl::macxMenuBarInit(GuiView * view, QMenuBar * qmb)
1308 /* Since Qt 4.2, the qt/mac menu code has special code for
1309 specifying the role of a menu entry. However, it does not
1310 work very well with our scheme of creating menus on demand,
1311 and therefore we need to put these entries in a special
1312 invisible menu. (JMarc)
1315 /* The entries of our special mac menu. If we add support for
1316 * special entries in Menus, we could imagine something
1318 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
1319 * and therefore avoid hardcoding. I am not sure it is worth
1320 * the hassle, though. (JMarc)
1322 struct MacMenuEntry {
1326 QAction::MenuRole role;
1329 MacMenuEntry entries[] = {
1330 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1331 QAction::AboutRole},
1332 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1333 QAction::PreferencesRole},
1334 {LFUN_RECONFIGURE, "", "Reconfigure",
1335 QAction::ApplicationSpecificRole},
1336 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1338 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1340 // the special menu for Menus. Fill it up only once.
1341 if (mac_special_menu_.size() == 0) {
1342 for (size_t i = 0 ; i < num_entries ; ++i) {
1343 FuncRequest const func(entries[i].action,
1344 from_utf8(entries[i].arg));
1345 mac_special_menu_.add(MenuItem(MenuItem::Command,
1346 entries[i].label, func));
1350 // add the entries to a QMenu that will eventually be empty
1351 // and therefore invisible.
1352 QMenu * qMenu = qmb->addMenu("special");
1353 MenuDefinition::const_iterator cit = mac_special_menu_.begin();
1354 MenuDefinition::const_iterator end = mac_special_menu_.end();
1355 for (size_t i = 0 ; cit != end ; ++cit, ++i) {
1356 Action * action = new Action(view, QIcon(), cit->label(),
1357 cit->func(), QString(), qMenu);
1358 action->setMenuRole(entries[i].role);
1359 qMenu->addAction(action);
1364 void Menus::Impl::expand(MenuDefinition const & frommenu,
1365 MenuDefinition & tomenu, BufferView const * bv) const
1367 if (!tomenu.empty())
1370 for (MenuDefinition::const_iterator cit = frommenu.begin();
1371 cit != frommenu.end() ; ++cit) {
1372 Buffer const * buf = bv ? &bv->buffer() : 0;
1373 switch (cit->kind()) {
1374 case MenuItem::Lastfiles:
1375 tomenu.expandLastfiles();
1378 case MenuItem::Documents:
1379 tomenu.expandDocuments();
1382 case MenuItem::Bookmarks:
1383 tomenu.expandBookmarks();
1386 case MenuItem::ImportFormats:
1387 case MenuItem::ViewFormats:
1388 case MenuItem::UpdateFormats:
1389 case MenuItem::ExportFormats:
1390 tomenu.expandFormats(cit->kind(), buf);
1393 case MenuItem::CharStyles:
1394 tomenu.expandFlexInsert(buf, InsetLayout::CHARSTYLE);
1397 case MenuItem::Custom:
1398 tomenu.expandFlexInsert(buf, InsetLayout::CUSTOM);
1401 case MenuItem::Elements:
1402 tomenu.expandFlexInsert(buf, InsetLayout::ELEMENT);
1405 case MenuItem::FloatListInsert:
1406 tomenu.expandFloatListInsert(buf);
1409 case MenuItem::FloatInsert:
1410 tomenu.expandFloatInsert(buf);
1413 case MenuItem::PasteRecent:
1414 tomenu.expandPasteRecent(buf);
1417 case MenuItem::Toolbars:
1418 tomenu.expandToolbars();
1421 case MenuItem::Branches:
1422 tomenu.expandBranches(buf);
1425 case MenuItem::CiteStyles:
1426 tomenu.expandCiteStyles(bv);
1430 tomenu.expandToc(buf);
1433 case MenuItem::GraphicsGroups:
1434 tomenu.expandGraphicsGroups(bv);
1437 case MenuItem::Submenu: {
1438 MenuItem item(*cit);
1439 item.setSubmenu(MenuDefinition(cit->submenuname()));
1440 expand(getMenu(cit->submenuname()), item.submenu(), bv);
1441 tomenu.addWithStatusCheck(item);
1445 case MenuItem::Info:
1446 case MenuItem::Help:
1447 case MenuItem::Separator:
1448 tomenu.addWithStatusCheck(*cit);
1451 case MenuItem::Command:
1452 if (!mac_special_menu_.hasFunc(cit->func()))
1453 tomenu.addWithStatusCheck(*cit);
1457 // we do not want the menu to end with a separator
1458 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
1459 tomenu.items_.pop_back();
1461 // Check whether the shortcuts are unique
1462 tomenu.checkShortcuts();
1466 bool Menus::Impl::hasMenu(QString const & name) const
1468 return find_if(menulist_.begin(), menulist_.end(),
1469 MenuNamesEqual(name)) != menulist_.end();
1473 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
1475 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
1476 MenuNamesEqual(name));
1477 if (cit == menulist_.end())
1478 LYXERR0("No submenu named " << name);
1479 LASSERT(cit != menulist_.end(), /**/);
1484 MenuDefinition & Menus::Impl::getMenu(QString const & name)
1486 iterator it = find_if(menulist_.begin(), menulist_.end(),
1487 MenuNamesEqual(name));
1488 if (it == menulist_.end())
1489 LYXERR0("No submenu named " << name);
1490 LASSERT(it != menulist_.end(), /**/);
1495 /////////////////////////////////////////////////////////////////////
1499 /////////////////////////////////////////////////////////////////////
1501 Menus::Menus() : d(new Impl) {}
1517 void Menus::read(Lexer & lex)
1525 LexerKeyword menutags[] = {
1526 { "end", md_endmenuset },
1527 { "menu", md_menu },
1528 { "menubar", md_menubar }
1531 // consistency check
1532 if (compare_ascii_no_case(lex.getString(), "menuset"))
1533 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
1535 lex.pushTable(menutags);
1536 lex.setContext("Menus::read");
1540 while (lex.isOK() && !quit) {
1541 switch (lex.lex()) {
1543 d->menubar_.read(lex);
1547 QString const name = toqstr(lex.getDocString());
1548 if (d->hasMenu(name))
1549 d->getMenu(name).read(lex);
1551 MenuDefinition menu(name);
1553 d->menulist_.push_back(menu);
1561 lex.printError("Unknown menu tag");
1569 bool Menus::searchMenu(FuncRequest const & func,
1570 docstring_list & names) const
1572 MenuDefinition menu;
1573 d->expand(d->menubar_, menu, 0);
1574 return menu.searchMenu(func, names);
1578 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
1582 // setup special mac specific menu items, but only do this
1583 // the first time a QMenuBar is created. Otherwise Qt will
1584 // create duplicate items in the application menu. It seems
1585 // that Qt does not remove them when the QMenubar is cleared.
1586 LYXERR(Debug::GUI, "Creating Mac OS X special menu bar");
1587 d->macxMenuBarInit(view, qmb);
1590 // Clear all menubar contents before filling it.
1594 LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
1596 if (d->menubar_.size() == 0) {
1597 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
1598 << d->menubar_.name());
1601 LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
1603 MenuDefinition menu;
1604 BufferView * bv = 0;
1607 d->expand(d->menubar_, menu, bv);
1609 MenuDefinition::const_iterator m = menu.begin();
1610 MenuDefinition::const_iterator end = menu.end();
1612 for (; m != end; ++m) {
1614 if (m->kind() != MenuItem::Submenu) {
1615 LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
1619 LYXERR(Debug::GUI, "menu bar item " << m->label()
1620 << " is a submenu named " << m->submenuname());
1622 QString name = m->submenuname();
1623 if (!d->hasMenu(name)) {
1624 LYXERR(Debug::GUI, "\tERROR: " << name
1625 << " submenu has no menu!");
1629 Menu * menu = new Menu(view, m->submenuname(), true);
1630 menu->setTitle(label(*m));
1633 d->name_map_[view][name] = menu;
1638 void Menus::updateMenu(Menu * qmenu)
1640 LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
1643 if (qmenu->d->name.isEmpty())
1646 // Here, We make sure that theLyXFunc points to the correct LyXView.
1647 theLyXFunc().setLyXView(qmenu->d->view);
1649 if (!d->hasMenu(qmenu->d->name)) {
1650 qmenu->addAction(qt_("No action defined!"));
1651 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
1656 MenuDefinition const & fromLyxMenu = d->getMenu(qmenu->d->name);
1657 BufferView * bv = 0;
1659 bv = qmenu->d->view->view();
1660 d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
1661 qmenu->d->populate(*qmenu, *qmenu->d->top_level_menu);
1665 Menu * Menus::menu(QString const & name, GuiView & view)
1667 LYXERR(Debug::GUI, "Context menu requested: " << name);
1668 Menu * menu = d->name_map_[&view].value(name, 0);
1669 if (!menu && !name.startsWith("context-")) {
1670 LYXERR0("requested context menu not found: " << name);
1674 menu = new Menu(&view, name, true);
1675 d->name_map_[&view][name] = menu;
1679 } // namespace frontend
1682 #include "moc_Menus.cpp"