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 is the list of last opened file,
99 typically for the File menu. */
101 /** This is the list of opened Documents,
102 typically for the Documents menu. */
104 /** This is the bookmarks */
108 /** This is a list of viewable formats
109 typically for the File->View menu. */
111 /** This is a list of updatable formats
112 typically for the File->Update menu. */
114 /** This is a list of exportable formats
115 typically for the File->Export menu. */
117 /** This is a list of importable formats
118 typically for the File->Export menu. */
120 /** This is the list of elements available
121 * for insertion into document. */
123 /** This is the list of user-configurable
124 insets to insert into document */
126 /** This is the list of XML elements to
127 insert into the document */
129 /** This is the list of floats that we can
130 insert a list for. */
132 /** This is the list of floats that we can
135 /** This is the list of selections that can
140 /** Available branches in document */
142 /** Available citation styles for a given citation */
144 /** Available graphics groups */
148 explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
151 QString const & label,
152 QString const & submenu = QString(),
153 bool optional = false)
154 : kind_(kind), label_(label), submenuname_(submenu), optional_(optional)
156 LASSERT(kind == Submenu, /**/);
160 QString const & label,
161 FuncRequest const & func,
162 bool optional = false)
163 : kind_(kind), label_(label), func_(func), optional_(optional)
165 func_.origin = FuncRequest::MENU;
168 // boost::shared_ptr<MenuDefinition> needs this apprently...
171 /// The label of a given menuitem
172 QString label() const { return label_.split('|')[0]; }
174 /// The keyboard shortcut (usually underlined in the entry)
175 QString shortcut() const
177 return label_.contains('|') ? label_.split('|')[1] : QString();
179 /// The complete label, with label and shortcut separated by a '|'
180 QString fulllabel() const { return label_;}
181 /// The kind of entry
182 Kind kind() const { return kind_; }
183 /// the action (if relevant)
184 FuncRequest const & func() const { return func_; }
185 /// returns true if the entry should be ommited when disabled
186 bool optional() const { return optional_; }
187 /// returns the status of the lfun associated with this entry
188 FuncStatus const & status() const { return status_; }
189 /// returns the status of the lfun associated with this entry
190 FuncStatus & status() { return status_; }
191 /// returns the status of the lfun associated with this entry
192 void status(FuncStatus const & status) { status_ = status; }
194 ///returns the binding associated to this action.
195 QString binding() const
197 if (kind_ != Command)
199 // Get the keys bound to this action, but keep only the
201 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
203 return toqstr(bindings.begin()->print(KeySequence::ForGui));
205 LYXERR(Debug::KBMAP, "No binding for "
206 << lyxaction.getActionName(func_.action)
207 << '(' << func_.argument() << ')');
211 /// the description of the submenu (if relevant)
212 QString const & submenuname() const { return submenuname_; }
213 /// set the description of the submenu
214 void submenuname(QString const & name) { submenuname_ = name; }
216 bool hasSubmenu() const { return !submenu_.isEmpty(); }
218 MenuDefinition const & submenu() const { return submenu_.at(0); }
219 MenuDefinition & submenu() { return submenu_[0]; }
221 void setSubmenu(MenuDefinition const & menu)
224 submenu_.append(menu);
235 QString submenuname_;
240 /// contains 0 or 1 item.
241 QList<MenuDefinition> submenu_;
245 class MenuDefinition {
248 typedef std::vector<MenuItem> ItemList;
250 typedef ItemList::const_iterator const_iterator;
252 explicit MenuDefinition(QString const & name = QString()) : name_(name) {}
257 QString const & name() const { return name_; }
259 bool empty() const { return items_.empty(); }
260 /// Clear the menu content.
261 void clear() { items_.clear(); }
263 size_t size() const { return items_.size(); }
265 MenuItem const & operator[](size_t) const;
267 const_iterator begin() const { return items_.begin(); }
269 const_iterator end() const { return items_.end(); }
271 // search for func in this menu iteratively, and put menu
273 bool searchMenu(FuncRequest const & func, docstring_list & names)
276 bool hasFunc(FuncRequest const &) const;
277 /// Add the menu item unconditionally
278 void add(MenuItem const & item) { items_.push_back(item); }
279 /// Checks the associated FuncRequest status before adding the
281 void addWithStatusCheck(MenuItem const &);
282 // Check whether the menu shortcuts are unique
283 void checkShortcuts() const;
285 void expandLastfiles();
286 void expandDocuments();
287 void expandBookmarks();
288 void expandFormats(MenuItem::Kind kind, Buffer const * buf);
289 void expandFloatListInsert(Buffer const * buf);
290 void expandFloatInsert(Buffer const * buf);
291 void expandFlexInsert(Buffer const * buf, std::string s);
292 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth);
293 void expandToc(Buffer const * buf);
294 void expandPasteRecent(Buffer const * buf);
295 void expandToolbars();
296 void expandBranches(Buffer const * buf);
297 void expandCiteStyles(BufferView const *);
298 void expandGraphicsGroups(BufferView const *);
306 /// Helper for std::find_if
310 MenuNamesEqual(QString const & name) : name_(name) {}
311 bool operator()(MenuDefinition const & menu) const { return menu.name() == name_; }
318 typedef std::vector<MenuDefinition> MenuList;
320 typedef MenuList::const_iterator const_iterator;
322 typedef MenuList::iterator iterator;
324 /////////////////////////////////////////////////////////////////////
325 // MenuDefinition implementation
326 /////////////////////////////////////////////////////////////////////
328 void MenuDefinition::addWithStatusCheck(MenuItem const & i)
332 case MenuItem::Command: {
333 FuncStatus status = lyx::getStatus(i.func());
334 if (status.unknown() || (!status.enabled() && i.optional()))
337 items_.back().status(status);
341 case MenuItem::Submenu: {
342 if (i.hasSubmenu()) {
343 bool enabled = false;
344 for (const_iterator cit = i.submenu().begin();
345 cit != i.submenu().end(); ++cit) {
346 if ((cit->kind() == MenuItem::Command
347 || cit->kind() == MenuItem::Submenu)
348 && cit->status().enabled()) {
353 if (enabled || !i.optional()) {
355 items_.back().status().setEnabled(enabled);
363 case MenuItem::Separator:
364 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
374 void MenuDefinition::read(Lexer & lex)
403 LexerKeyword menutags[] = {
404 { "bookmarks", md_bookmarks },
405 { "branches", md_branches },
406 { "charstyles", md_charstyles },
407 { "citestyles", md_citestyles },
408 { "custom", md_custom },
409 { "documents", md_documents },
410 { "elements", md_elements },
411 { "end", md_endmenu },
412 { "exportformats", md_exportformats },
413 { "floatinsert", md_floatinsert },
414 { "floatlistinsert", md_floatlistinsert },
415 { "graphicsgroups", md_graphicsgroups },
416 { "importformats", md_importformats },
418 { "lastfiles", md_lastfiles },
419 { "optitem", md_optitem },
420 { "optsubmenu", md_optsubmenu },
421 { "pasterecent", md_pasterecent },
422 { "separator", md_separator },
423 { "submenu", md_submenu },
425 { "toolbars", md_toolbars },
426 { "updateformats", md_updateformats },
427 { "viewformats", md_viewformats }
430 lex.pushTable(menutags);
431 lex.setContext("MenuDefinition::read: ");
434 bool optional = false;
436 while (lex.isOK() && !quit) {
440 // fallback to md_item
443 docstring const name = translateIfPossible(lex.getDocString());
445 string const command = lex.getString();
446 FuncRequest func = lyxaction.lookupFunc(command);
447 add(MenuItem(MenuItem::Command, toqstr(name), func, optional));
453 add(MenuItem(MenuItem::Separator));
457 add(MenuItem(MenuItem::Lastfiles));
461 add(MenuItem(MenuItem::CharStyles));
465 add(MenuItem(MenuItem::Custom));
469 add(MenuItem(MenuItem::Elements));
473 add(MenuItem(MenuItem::Documents));
477 add(MenuItem(MenuItem::Bookmarks));
481 add(MenuItem(MenuItem::Toc));
485 add(MenuItem(MenuItem::ViewFormats));
488 case md_updateformats:
489 add(MenuItem(MenuItem::UpdateFormats));
492 case md_exportformats:
493 add(MenuItem(MenuItem::ExportFormats));
496 case md_importformats:
497 add(MenuItem(MenuItem::ImportFormats));
500 case md_floatlistinsert:
501 add(MenuItem(MenuItem::FloatListInsert));
505 add(MenuItem(MenuItem::FloatInsert));
509 add(MenuItem(MenuItem::PasteRecent));
513 add(MenuItem(MenuItem::Toolbars));
517 add(MenuItem(MenuItem::Branches));
521 add(MenuItem(MenuItem::CiteStyles));
524 case md_graphicsgroups:
525 add(MenuItem(MenuItem::GraphicsGroups));
530 // fallback to md_submenu
533 docstring const mlabel = translateIfPossible(lex.getDocString());
535 docstring const mname = lex.getDocString();
536 add(MenuItem(MenuItem::Submenu,
537 toqstr(mlabel), toqstr(mname), optional));
547 lex.printError("Unknown menu tag");
555 MenuItem const & MenuDefinition::operator[](size_type i) const
561 bool MenuDefinition::hasFunc(FuncRequest const & func) const
563 for (const_iterator it = begin(), et = end(); it != et; ++it)
564 if (it->func() == func)
570 void MenuDefinition::checkShortcuts() const
572 // This is a quadratic algorithm, but we do not care because
573 // menus are short enough
574 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
575 QString shortcut = it1->shortcut();
576 if (shortcut.isEmpty())
578 if (!it1->label().contains(shortcut))
579 LYXERR0("Menu warning: menu entry \""
581 << "\" does not contain shortcut `"
582 << shortcut << "'.");
583 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
584 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
585 LYXERR0("Menu warning: menu entries "
586 << '"' << it1->fulllabel()
587 << "\" and \"" << it2->fulllabel()
588 << "\" share the same shortcut.");
595 bool MenuDefinition::searchMenu(FuncRequest const & func, docstring_list & names) const
597 const_iterator m = begin();
598 const_iterator m_end = end();
599 for (; m != m_end; ++m) {
600 if (m->kind() == MenuItem::Command && m->func() == func) {
601 names.push_back(qstring_to_ucs4(m->label()));
604 if (m->kind() == MenuItem::Submenu) {
605 names.push_back(qstring_to_ucs4(m->label()));
606 if (!m->hasSubmenu()) {
607 LYXERR(Debug::GUI, "Warning: non existing sub menu label="
608 << m->label() << " name=" << m->submenuname());
612 if (m->submenu().searchMenu(func, names))
621 bool compareFormat(Format const * p1, Format const * p2)
627 QString limitStringLength(docstring const & str)
629 size_t const max_item_length = 45;
631 if (str.size() > max_item_length)
632 return toqstr(str.substr(0, max_item_length - 3) + "...");
638 void MenuDefinition::expandGraphicsGroups(BufferView const * bv)
643 graphics::getGraphicsGroups(bv->buffer(), grp);
647 set<string>::const_iterator it = grp.begin();
648 set<string>::const_iterator end = grp.end();
649 add(MenuItem(MenuItem::Command, qt_("No Group"),
650 FuncRequest(LFUN_SET_GRAPHICS_GROUP)));
651 for (; it != end; it++) {
652 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(*it),
653 FuncRequest(LFUN_SET_GRAPHICS_GROUP, *it)));
657 void MenuDefinition::expandLastfiles()
659 LastFilesSection::LastFiles const & lf = theSession().lastFiles().lastFiles();
660 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
664 for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
665 string const file = lfit->absFilename();
666 QString const label = QString("%1. %2|%3").arg(ii)
667 .arg(toqstr(makeDisplayPath(file, 30))).arg(ii);
668 add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
673 void MenuDefinition::expandDocuments()
675 Buffer * first = theBufferList().first();
680 // We cannot use a for loop as the buffer list cycles.
682 QString label = toqstr(b->fileName().displayName(20));
683 if (b->isUnnamed() && label.endsWith(".internal")) {
684 // This is an internal Buffer (eg. for clipboard operations)
685 b = theBufferList().next(b);
691 label = QString::number(ii) + ". " + label + '|' + QString::number(ii);
692 add(MenuItem(MenuItem::Command, label,
693 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
695 b = theBufferList().next(b);
697 } while (b != first);
699 add(MenuItem(MenuItem::Command, qt_("No Documents Open!"),
700 FuncRequest(LFUN_NOACTION)));
705 void MenuDefinition::expandBookmarks()
707 lyx::BookmarksSection const & bm = theSession().bookmarks();
709 for (size_t i = 1; i <= bm.size(); ++i) {
711 string const file = bm.bookmark(i).filename.absFilename();
712 QString const label = QString("%1. %2|%3").arg(i)
713 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
714 add(MenuItem(MenuItem::Command, label,
715 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
721 void MenuDefinition::expandFormats(MenuItem::Kind kind, Buffer const * buf)
723 if (!buf && kind != MenuItem::ImportFormats) {
724 add(MenuItem(MenuItem::Command,
725 qt_("No Document Open!"),
726 FuncRequest(LFUN_NOACTION)));
730 typedef vector<Format const *> Formats;
735 case MenuItem::ImportFormats:
736 formats = theConverters().importableFormats();
737 action = LFUN_BUFFER_IMPORT;
739 case MenuItem::ViewFormats:
740 formats = buf->exportableFormats(true);
741 action = LFUN_BUFFER_VIEW;
743 case MenuItem::UpdateFormats:
744 formats = buf->exportableFormats(true);
745 action = LFUN_BUFFER_UPDATE;
748 formats = buf->exportableFormats(false);
749 action = LFUN_BUFFER_EXPORT;
751 sort(formats.begin(), formats.end(), &compareFormat);
753 Formats::const_iterator fit = formats.begin();
754 Formats::const_iterator end = formats.end();
755 for (; fit != end ; ++fit) {
759 docstring lab = from_utf8((*fit)->prettyname());
760 docstring scut = from_utf8((*fit)->shortcut());
761 docstring const tmplab = lab;
764 lab += char_type('|') + scut;
765 docstring lab_i18n = translateIfPossible(lab);
766 bool const untranslated = (lab == lab_i18n);
767 QString const shortcut = toqstr(split(lab_i18n, lab, '|'));
768 QString label = toqstr(lab);
770 // this might happen if the shortcut
771 // has been redefined
772 label = toqstr(translateIfPossible(tmplab));
775 case MenuItem::ImportFormats:
778 case MenuItem::ViewFormats:
779 case MenuItem::ExportFormats:
780 case MenuItem::UpdateFormats:
781 if (!(*fit)->documentFormat())
785 LASSERT(false, /**/);
788 if (!shortcut.isEmpty())
789 label += '|' + shortcut;
792 addWithStatusCheck(MenuItem(MenuItem::Command, label,
793 FuncRequest(action, (*fit)->name())));
795 add(MenuItem(MenuItem::Command, label,
796 FuncRequest(action, (*fit)->name())));
801 void MenuDefinition::expandFloatListInsert(Buffer const * buf)
804 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
805 FuncRequest(LFUN_NOACTION)));
809 FloatList const & floats = buf->params().documentClass().floats();
810 FloatList::const_iterator cit = floats.begin();
811 FloatList::const_iterator end = floats.end();
812 for (; cit != end; ++cit) {
813 addWithStatusCheck(MenuItem(MenuItem::Command,
814 qt_(cit->second.listName()),
815 FuncRequest(LFUN_FLOAT_LIST_INSERT,
816 cit->second.type())));
821 void MenuDefinition::expandFloatInsert(Buffer const * buf)
824 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
825 FuncRequest(LFUN_NOACTION)));
829 FloatList const & floats = buf->params().documentClass().floats();
830 FloatList::const_iterator cit = floats.begin();
831 FloatList::const_iterator end = floats.end();
832 for (; cit != end; ++cit) {
834 QString const label = qt_(cit->second.name());
835 addWithStatusCheck(MenuItem(MenuItem::Command, label,
836 FuncRequest(LFUN_FLOAT_INSERT,
837 cit->second.type())));
842 void MenuDefinition::expandFlexInsert(Buffer const * buf, string s)
845 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
846 FuncRequest(LFUN_NOACTION)));
849 TextClass::InsetLayouts const & insetLayouts =
850 buf->params().documentClass().insetLayouts();
851 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
852 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
853 bool addedOne = false;
854 for (; cit != end; ++cit) {
855 docstring const label = cit->first;
856 if (cit->second.lyxtype() == s) {
857 addWithStatusCheck(MenuItem(MenuItem::Command,
858 toqstr(translateIfPossible(label)),
859 FuncRequest(LFUN_FLEX_INSERT, label)));
863 // FIXME This is a little clunky.
864 if (!addedOne && s == "custom")
865 add(MenuItem(MenuItem::Command,
866 qt_("No custom insets defined!"),
867 FuncRequest(LFUN_NOACTION)));
871 size_t const max_number_of_items = 25;
873 void MenuDefinition::expandToc2(Toc const & toc_list,
874 size_t from, size_t to, int depth)
876 int shortcut_count = 0;
878 // check whether depth is smaller than the smallest depth in toc.
879 int min_depth = 1000;
880 for (size_t i = from; i < to; ++i)
881 min_depth = min(min_depth, toc_list[i].depth());
882 if (min_depth > depth)
885 if (to - from <= max_number_of_items) {
886 for (size_t i = from; i < to; ++i) {
887 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
888 label += limitStringLength(toc_list[i].str());
889 if (toc_list[i].depth() == depth
890 && shortcut_count < 9) {
891 if (label.contains(QString::number(shortcut_count + 1)))
892 label += '|' + QString::number(++shortcut_count);
894 add(MenuItem(MenuItem::Command, label,
895 FuncRequest(toc_list[i].action())));
900 size_t new_pos = pos + 1;
901 while (new_pos < to && toc_list[new_pos].depth() > depth)
904 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
905 label += limitStringLength(toc_list[pos].str());
906 if (toc_list[pos].depth() == depth &&
907 shortcut_count < 9) {
908 if (label.contains(QString::number(shortcut_count + 1)))
909 label += '|' + QString::number(++shortcut_count);
911 if (new_pos == pos + 1) {
912 add(MenuItem(MenuItem::Command,
913 label, FuncRequest(toc_list[pos].action())));
916 sub.expandToc2(toc_list, pos, new_pos, depth + 1);
917 MenuItem item(MenuItem::Submenu, label);
918 item.setSubmenu(sub);
927 void MenuDefinition::expandToc(Buffer const * buf)
929 // To make things very cleanly, we would have to pass buf to
930 // all MenuItem constructors and to expandToc2. However, we
931 // know that all the entries in a TOC will be have status_ ==
932 // OK, so we avoid this unnecessary overhead (JMarc)
935 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
936 FuncRequest(LFUN_NOACTION)));
940 // Add an entry for the master doc if this is a child doc
941 Buffer const * const master = buf->masterBuffer();
943 ParIterator const pit = par_iterator_begin(master->inset());
944 string const arg = convert<string>(pit->id());
945 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
946 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
949 MenuDefinition other_lists;
951 FloatList const & floatlist = buf->params().documentClass().floats();
952 TocList const & toc_list = buf->tocBackend().tocs();
953 TocList::const_iterator cit = toc_list.begin();
954 TocList::const_iterator end = toc_list.end();
955 for (; cit != end; ++cit) {
957 if (cit->first == "tableofcontents")
960 MenuDefinition submenu;
961 if (cit->second.size() >= 30) {
962 FuncRequest f(LFUN_DIALOG_SHOW, "toc " + cit->first);
963 submenu.add(MenuItem(MenuItem::Command, qt_("Open Navigator..."), f));
965 TocIterator ccit = cit->second.begin();
966 TocIterator eend = cit->second.end();
967 for (; ccit != eend; ++ccit) {
968 submenu.add(MenuItem(MenuItem::Command,
969 limitStringLength(ccit->str()),
970 FuncRequest(ccit->action())));
974 MenuItem item(MenuItem::Submenu, guiName(cit->first, buf->params()));
975 item.setSubmenu(submenu);
976 if (floatlist.typeExist(cit->first) || cit->first == "child") {
977 // Those two types deserve to be in the main menu.
978 item.setSubmenu(submenu);
981 other_lists.add(item);
983 if (!other_lists.empty()) {
984 MenuItem item(MenuItem::Submenu, qt_("Other Lists"));
985 item.setSubmenu(other_lists);
990 cit = toc_list.find("tableofcontents");
992 addWithStatusCheck(MenuItem(MenuItem::Command,
993 qt_("No Table of contents"),
996 expandToc2(cit->second, 0, cit->second.size(), 0);
1000 void MenuDefinition::expandPasteRecent(Buffer const * buf)
1002 docstring_list const sel = cap::availableSelections(buf);
1004 docstring_list::const_iterator cit = sel.begin();
1005 docstring_list::const_iterator end = sel.end();
1007 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1008 add(MenuItem(MenuItem::Command, toqstr(*cit),
1009 FuncRequest(LFUN_PASTE, convert<string>(index))));
1014 void MenuDefinition::expandToolbars()
1016 MenuDefinition other_lists;
1017 // extracts the toolbars from the backend
1018 Toolbars::Infos::const_iterator cit = guiApp->toolbars().begin();
1019 Toolbars::Infos::const_iterator end = guiApp->toolbars().end();
1020 for (; cit != end; ++cit) {
1021 MenuItem const item(MenuItem::Command, toqstr(cit->gui_name),
1022 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name));
1023 if (guiApp->toolbars().isMainToolbar(cit->name))
1026 other_lists.add(item);
1029 if (!other_lists.empty()) {
1030 MenuItem item(MenuItem::Submenu, qt_("Other Toolbars"));
1031 item.setSubmenu(other_lists);
1037 void MenuDefinition::expandBranches(Buffer const * buf)
1040 add(MenuItem(MenuItem::Command,
1041 qt_("No Document Open!"),
1042 FuncRequest(LFUN_NOACTION)));
1046 BufferParams const & params = buf->masterBuffer()->params();
1047 if (params.branchlist().empty()) {
1048 add(MenuItem(MenuItem::Command,
1049 qt_("No Branch in Document!"),
1050 FuncRequest(LFUN_NOACTION)));
1054 BranchList::const_iterator cit = params.branchlist().begin();
1055 BranchList::const_iterator end = params.branchlist().end();
1057 for (int ii = 1; cit != end; ++cit, ++ii) {
1058 docstring label = cit->branch();
1060 label = convert<docstring>(ii) + ". " + label
1061 + char_type('|') + convert<docstring>(ii);
1063 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1064 FuncRequest(LFUN_BRANCH_INSERT,
1070 void MenuDefinition::expandCiteStyles(BufferView const * bv)
1073 add(MenuItem(MenuItem::Command,
1074 qt_("No Document Open!"),
1075 FuncRequest(LFUN_NOACTION)));
1079 Inset const * inset = bv->cursor().nextInset();
1080 if (!inset || inset->lyxCode() != CITE_CODE) {
1081 add(MenuItem(MenuItem::Command,
1082 qt_("No Citation in Scope!"),
1083 FuncRequest(LFUN_NOACTION)));
1086 InsetCommand const * citinset =
1087 static_cast<InsetCommand const *>(inset);
1089 Buffer const * buf = &bv->buffer();
1090 docstring key = citinset->getParam("key");
1091 // we can only handle one key currently
1092 if (contains(key, ','))
1093 key = qstring_to_ucs4(toqstr(key).split(',')[0]);
1095 vector<CiteStyle> citeStyleList = citeStyles(buf->params().citeEngine());
1096 docstring_list citeStrings =
1097 buf->masterBibInfo().getCiteStrings(key, bv->buffer());
1099 docstring_list::const_iterator cit = citeStrings.begin();
1100 docstring_list::const_iterator end = citeStrings.end();
1102 for (int ii = 1; cit != end; ++cit, ++ii) {
1103 docstring label = *cit;
1105 CiteStyle cst = citeStyleList[ii - 1];
1107 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1108 FuncRequest(LFUN_NEXT_INSET_MODIFY,
1109 "changetype " + from_utf8(citationStyleToString(cs)))));
1116 /////////////////////////////////////////////////////////////////////
1117 // Menu::Impl definition and implementation
1118 /////////////////////////////////////////////////////////////////////
1122 /// populates the menu or one of its submenu
1123 /// This is used as a recursive function
1124 void populate(QMenu & qMenu, MenuDefinition const & menu);
1126 /// Only needed for top level menus.
1127 MenuDefinition * top_level_menu;
1130 /// the name of this menu
1136 /// Get a MenuDefinition item label from the menu backend
1137 static QString label(MenuItem const & mi)
1139 QString label = mi.label();
1140 label.replace("&", "&&");
1142 QString shortcut = mi.shortcut();
1143 if (!shortcut.isEmpty()) {
1144 int pos = label.indexOf(shortcut);
1146 //label.insert(pos, 1, char_type('&'));
1147 label.replace(pos, 0, "&");
1150 QString const binding = mi.binding();
1151 if (!binding.isEmpty())
1152 label += '\t' + binding;
1157 void Menu::Impl::populate(QMenu & qMenu, MenuDefinition const & menu)
1159 LYXERR(Debug::GUI, "populating menu " << menu.name());
1160 if (menu.size() == 0) {
1161 LYXERR(Debug::GUI, "\tERROR: empty menu " << menu.name());
1164 LYXERR(Debug::GUI, " ***** menu entries " << menu.size());
1165 MenuDefinition::const_iterator m = menu.begin();
1166 MenuDefinition::const_iterator end = menu.end();
1167 for (; m != end; ++m) {
1168 if (m->kind() == MenuItem::Separator)
1169 qMenu.addSeparator();
1170 else if (m->kind() == MenuItem::Submenu) {
1171 QMenu * subMenu = qMenu.addMenu(label(*m));
1172 populate(*subMenu, m->submenu());
1174 // we have a MenuItem::Command
1175 qMenu.addAction(new Action(view, QIcon(), label(*m),
1176 m->func(), QString(), &qMenu));
1181 /////////////////////////////////////////////////////////////////////
1182 // Menu implementation
1183 /////////////////////////////////////////////////////////////////////
1185 Menu::Menu(GuiView * gv, QString const & name, bool top_level)
1186 : QMenu(gv), d(new Menu::Impl)
1188 d->top_level_menu = top_level? new MenuDefinition : 0;
1192 if (d->top_level_menu)
1193 connect(this, SIGNAL(aboutToShow()), this, SLOT(updateView()));
1199 delete d->top_level_menu;
1204 void Menu::updateView()
1206 guiApp->menus().updateMenu(this);
1210 /////////////////////////////////////////////////////////////////////
1211 // Menus::Impl definition and implementation
1212 /////////////////////////////////////////////////////////////////////
1214 struct Menus::Impl {
1216 bool hasMenu(QString const &) const;
1218 MenuDefinition & getMenu(QString const &);
1220 MenuDefinition const & getMenu(QString const &) const;
1222 /// Expands some special entries of the menu
1223 /** The entries with the following kind are expanded to a
1224 sequence of Command MenuItems: Lastfiles, Documents,
1225 ViewFormats, ExportFormats, UpdateFormats, Branches
1227 void expand(MenuDefinition const & frommenu, MenuDefinition & tomenu,
1228 BufferView const *) const;
1230 /// Initialize specific MACOS X menubar
1231 void macxMenuBarInit(GuiView * view, QMenuBar * qmb);
1233 /// Mac special menu.
1234 /** This defines a menu whose entries list the FuncRequests
1235 that will be removed by expand() in other menus. This is
1236 used by the Qt/Mac code
1238 MenuDefinition specialmenu_;
1243 MenuDefinition menubar_;
1245 typedef QMap<GuiView *, QHash<QString, Menu*> > NameMap;
1247 /// name to menu for \c menu() method.
1252 Here is what the Qt documentation says about how a menubar is chosen:
1254 1) If the window has a QMenuBar then it is used. 2) If the window
1255 is a modal then its menubar is used. If no menubar is specified
1256 then a default menubar is used (as documented below) 3) If the
1257 window has no parent then the default menubar is used (as
1260 The above 3 steps are applied all the way up the parent window
1261 chain until one of the above are satisifed. If all else fails a
1262 default menubar will be created, the default menubar on Qt/Mac is
1263 an empty menubar, however you can create a different default
1264 menubar by creating a parentless QMenuBar, the first one created
1265 will thus be designated the default menubar, and will be used
1266 whenever a default menubar is needed.
1268 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1269 that this menubar will be used also when one of LyX' dialogs has
1272 void Menus::Impl::macxMenuBarInit(GuiView * view, QMenuBar * qmb)
1274 /* Since Qt 4.2, the qt/mac menu code has special code for
1275 specifying the role of a menu entry. However, it does not
1276 work very well with our scheme of creating menus on demand,
1277 and therefore we need to put these entries in a special
1278 invisible menu. (JMarc)
1281 /* The entries of our special mac menu. If we add support for
1282 * special entries in Menus, we could imagine something
1284 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
1285 * and therefore avoid hardcoding. I am not sure it is worth
1286 * the hassle, though. (JMarc)
1288 struct MacMenuEntry {
1292 QAction::MenuRole role;
1295 MacMenuEntry entries[] = {
1296 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1297 QAction::AboutRole},
1298 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1299 QAction::PreferencesRole},
1300 {LFUN_RECONFIGURE, "", "Reconfigure",
1301 QAction::ApplicationSpecificRole},
1302 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1304 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1306 // the special menu for Menus. Fill it up only once.
1307 if (specialmenu_.size() == 0) {
1308 for (size_t i = 0 ; i < num_entries ; ++i) {
1309 FuncRequest const func(entries[i].action,
1310 from_utf8(entries[i].arg));
1311 specialmenu_.add(MenuItem(MenuItem::Command,
1312 entries[i].label, func));
1316 // add the entries to a QMenu that will eventually be empty
1317 // and therefore invisible.
1318 QMenu * qMenu = qmb->addMenu("special");
1319 MenuDefinition::const_iterator cit = specialmenu_.begin();
1320 MenuDefinition::const_iterator end = specialmenu_.end();
1321 for (size_t i = 0 ; cit != end ; ++cit, ++i) {
1322 Action * action = new Action(view, QIcon(), cit->label(),
1323 cit->func(), QString(), qMenu);
1324 action->setMenuRole(entries[i].role);
1325 qMenu->addAction(action);
1330 void Menus::Impl::expand(MenuDefinition const & frommenu,
1331 MenuDefinition & tomenu, BufferView const * bv) const
1333 if (!tomenu.empty())
1336 for (MenuDefinition::const_iterator cit = frommenu.begin();
1337 cit != frommenu.end() ; ++cit) {
1338 Buffer const * buf = bv ? &bv->buffer() : 0;
1339 switch (cit->kind()) {
1340 case MenuItem::Lastfiles:
1341 tomenu.expandLastfiles();
1344 case MenuItem::Documents:
1345 tomenu.expandDocuments();
1348 case MenuItem::Bookmarks:
1349 tomenu.expandBookmarks();
1352 case MenuItem::ImportFormats:
1353 case MenuItem::ViewFormats:
1354 case MenuItem::UpdateFormats:
1355 case MenuItem::ExportFormats:
1356 tomenu.expandFormats(cit->kind(), buf);
1359 case MenuItem::CharStyles:
1360 tomenu.expandFlexInsert(buf, "charstyle");
1363 case MenuItem::Custom:
1364 tomenu.expandFlexInsert(buf, "custom");
1367 case MenuItem::Elements:
1368 tomenu.expandFlexInsert(buf, "element");
1371 case MenuItem::FloatListInsert:
1372 tomenu.expandFloatListInsert(buf);
1375 case MenuItem::FloatInsert:
1376 tomenu.expandFloatInsert(buf);
1379 case MenuItem::PasteRecent:
1380 tomenu.expandPasteRecent(buf);
1383 case MenuItem::Toolbars:
1384 tomenu.expandToolbars();
1387 case MenuItem::Branches:
1388 tomenu.expandBranches(buf);
1391 case MenuItem::CiteStyles:
1392 tomenu.expandCiteStyles(bv);
1396 tomenu.expandToc(buf);
1399 case MenuItem::GraphicsGroups:
1400 tomenu.expandGraphicsGroups(bv);
1403 case MenuItem::Submenu: {
1404 MenuItem item(*cit);
1405 item.setSubmenu(MenuDefinition(cit->submenuname()));
1406 expand(getMenu(cit->submenuname()), item.submenu(), bv);
1407 tomenu.addWithStatusCheck(item);
1411 case MenuItem::Separator:
1412 tomenu.addWithStatusCheck(*cit);
1415 case MenuItem::Command:
1416 if (!specialmenu_.hasFunc(cit->func()))
1417 tomenu.addWithStatusCheck(*cit);
1421 // we do not want the menu to end with a separator
1422 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
1423 tomenu.items_.pop_back();
1425 // Check whether the shortcuts are unique
1426 tomenu.checkShortcuts();
1430 bool Menus::Impl::hasMenu(QString const & name) const
1432 return find_if(menulist_.begin(), menulist_.end(),
1433 MenuNamesEqual(name)) != menulist_.end();
1437 MenuDefinition const & Menus::Impl::getMenu(QString const & name) const
1439 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
1440 MenuNamesEqual(name));
1441 if (cit == menulist_.end())
1442 LYXERR0("No submenu named " << name);
1443 LASSERT(cit != menulist_.end(), /**/);
1448 MenuDefinition & Menus::Impl::getMenu(QString const & name)
1450 iterator it = find_if(menulist_.begin(), menulist_.end(),
1451 MenuNamesEqual(name));
1452 if (it == menulist_.end())
1453 LYXERR0("No submenu named " << name);
1454 LASSERT(it != menulist_.end(), /**/);
1459 /////////////////////////////////////////////////////////////////////
1463 /////////////////////////////////////////////////////////////////////
1465 Menus::Menus() : d(new Impl) {}
1481 void Menus::read(Lexer & lex)
1489 LexerKeyword menutags[] = {
1490 { "end", md_endmenuset },
1491 { "menu", md_menu },
1492 { "menubar", md_menubar }
1495 // consistency check
1496 if (compare_ascii_no_case(lex.getString(), "menuset"))
1497 LYXERR0("Menus::read: ERROR wrong token: `" << lex.getString() << '\'');
1499 lex.pushTable(menutags);
1500 lex.setContext("Menus::read");
1504 while (lex.isOK() && !quit) {
1505 switch (lex.lex()) {
1507 d->menubar_.read(lex);
1511 QString const name = toqstr(lex.getDocString());
1512 if (d->hasMenu(name))
1513 d->getMenu(name).read(lex);
1515 MenuDefinition menu(name);
1517 d->menulist_.push_back(menu);
1525 lex.printError("Unknown menu tag");
1533 bool Menus::searchMenu(FuncRequest const & func,
1534 docstring_list & names) const
1536 MenuDefinition menu;
1537 d->expand(d->menubar_, menu, 0);
1538 return menu.searchMenu(func, names);
1542 void Menus::fillMenuBar(QMenuBar * qmb, GuiView * view, bool initial)
1546 // setup special mac specific menu item
1547 d->macxMenuBarInit(view, qmb);
1550 // Clear all menubar contents before filling it.
1554 LYXERR(Debug::GUI, "populating menu bar" << d->menubar_.name());
1556 if (d->menubar_.size() == 0) {
1557 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
1558 << d->menubar_.name());
1561 LYXERR(Debug::GUI, "menu bar entries " << d->menubar_.size());
1563 MenuDefinition menu;
1564 BufferView * bv = 0;
1567 d->expand(d->menubar_, menu, bv);
1569 MenuDefinition::const_iterator m = menu.begin();
1570 MenuDefinition::const_iterator end = menu.end();
1572 for (; m != end; ++m) {
1574 if (m->kind() != MenuItem::Submenu) {
1575 LYXERR(Debug::GUI, "\tERROR: not a submenu " << m->label());
1579 LYXERR(Debug::GUI, "menu bar item " << m->label()
1580 << " is a submenu named " << m->submenuname());
1582 QString name = m->submenuname();
1583 if (!d->hasMenu(name)) {
1584 LYXERR(Debug::GUI, "\tERROR: " << name
1585 << " submenu has no menu!");
1589 Menu * menu = new Menu(view, m->submenuname(), true);
1590 menu->setTitle(label(*m));
1593 d->name_map_[view][name] = menu;
1598 void Menus::updateMenu(Menu * qmenu)
1600 LYXERR(Debug::GUI, "Triggered menu: " << qmenu->d->name);
1603 if (qmenu->d->name.isEmpty())
1606 // Here, We make sure that theLyXFunc points to the correct LyXView.
1607 theLyXFunc().setLyXView(qmenu->d->view);
1609 if (!d->hasMenu(qmenu->d->name)) {
1610 qmenu->addAction(qt_("No action defined!"));
1611 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
1616 MenuDefinition const & fromLyxMenu = d->getMenu(qmenu->d->name);
1617 BufferView * bv = 0;
1619 bv = qmenu->d->view->view();
1620 d->expand(fromLyxMenu, *qmenu->d->top_level_menu, bv);
1621 qmenu->d->populate(*qmenu, *qmenu->d->top_level_menu);
1625 Menu * Menus::menu(QString const & name, GuiView & view)
1627 LYXERR(Debug::GUI, "Context menu requested: " << name);
1628 Menu * menu = d->name_map_[&view].value(name, 0);
1629 if (!menu && !name.startsWith("context-")) {
1630 LYXERR0("requested context menu not found: " << name);
1634 menu = new Menu(&view, name, true);
1635 d->name_map_[&view][name] = menu;
1639 } // namespace frontend
1642 #include "Menus_moc.cpp"