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 Bø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 "BranchList.h"
28 #include "BufferList.h"
29 #include "BufferParams.h"
30 #include "Converter.h"
31 #include "CutAndPaste.h"
33 #include "FloatList.h"
35 #include "FuncRequest.h"
36 #include "FuncStatus.h"
39 #include "LyXAction.h"
40 #include "LyX.h" // for lastfiles
42 #include "Paragraph.h"
44 #include "TextClass.h"
45 #include "TocBackend.h"
46 #include "ToolbarBackend.h"
48 #include "support/convert.h"
49 #include "support/debug.h"
50 #include "support/filetools.h"
51 #include "support/gettext.h"
52 #include "support/lstrings.h"
59 #include <boost/shared_ptr.hpp>
66 using namespace lyx::support;
74 // MacOSX specific stuff is at the end.
81 /// The type of elements that can be in a menu
89 /** This is the list of last opened file,
90 typically for the File menu. */
92 /** This is the list of opened Documents,
93 typically for the Documents menu. */
95 /** This is the bookmarks */
99 /** This is a list of viewable formats
100 typically for the File->View menu. */
102 /** This is a list of updatable formats
103 typically for the File->Update menu. */
105 /** This is a list of exportable formats
106 typically for the File->Export menu. */
108 /** This is a list of importable formats
109 typically for the File->Export menu. */
111 /** This is the list of elements available
112 * for insertion into document. */
114 /** This is the list of user-configurable
115 insets to insert into document */
117 /** This is the list of XML elements to
118 insert into the document */
120 /** This is the list of floats that we can
121 insert a list for. */
123 /** This is the list of floats that we can
126 /** This is the list of selections that can
131 /** Available branches in document */
135 explicit MenuItem(Kind kind) : kind_(kind), optional_(false) {}
138 QString const & label,
139 QString const & submenu = QString(),
140 bool optional = false)
141 : kind_(kind), label_(label), submenuname_(submenu), optional_(optional)
143 BOOST_ASSERT(kind == Submenu);
147 QString const & label,
148 FuncRequest const & func,
149 bool optional = false)
150 : kind_(kind), label_(label), func_(func), optional_(optional)
152 func_.origin = FuncRequest::MENU;
155 // boost::shared_ptr<Menu> needs this apprently...
158 /// The label of a given menuitem
159 QString label() const { return label_.split('|')[0]; }
161 /// The keyboard shortcut (usually underlined in the entry)
162 QString shortcut() const
164 return label_.contains('|') ? label_.split('|')[1] : QString();
166 /// The complete label, with label and shortcut separated by a '|'
167 QString fulllabel() const { return label_;}
168 /// The kind of entry
169 Kind kind() const { return kind_; }
170 /// the action (if relevant)
171 FuncRequest const & func() const { return func_; }
172 /// returns true if the entry should be ommited when disabled
173 bool optional() const { return optional_; }
174 /// returns the status of the lfun associated with this entry
175 FuncStatus const & status() const { return status_; }
176 /// returns the status of the lfun associated with this entry
177 FuncStatus & status() { return status_; }
178 /// returns the status of the lfun associated with this entry
179 void status(FuncStatus const & status) { status_ = status; }
181 ///returns the binding associated to this action.
182 QString binding() const
184 if (kind_ != Command)
186 // Get the keys bound to this action, but keep only the
188 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
190 return toqstr(bindings.begin()->print(KeySequence::ForGui));
192 LYXERR(Debug::KBMAP, "No binding for "
193 << lyxaction.getActionName(func_.action)
194 << '(' << func_.argument() << ')');
198 /// the description of the submenu (if relevant)
199 QString const & submenuname() const { return submenuname_; }
200 /// set the description of the submenu
201 void submenuname(QString const & name) { submenuname_ = name; }
203 Menu * submenu() const { return submenu_.get(); }
205 void setSubmenu(Menu * menu) { submenu_.reset(menu); }
215 QString submenuname_;
221 boost::shared_ptr<Menu> submenu_;
228 typedef std::vector<MenuItem> ItemList;
230 typedef ItemList::const_iterator const_iterator;
232 explicit Menu(QString const & name = QString()) : name_(name) {}
237 QString const & name() const { return name_; }
239 bool empty() const { return items_.empty(); }
240 /// Clear the menu content.
241 void clear() { items_.clear(); }
243 size_t size() const { return items_.size(); }
245 MenuItem const & operator[](size_t) const;
247 const_iterator begin() const { return items_.begin(); }
249 const_iterator end() const { return items_.end(); }
251 // search for func in this menu iteratively, and put menu
253 bool searchMenu(FuncRequest const & func, std::vector<docstring> & names)
256 bool hasFunc(FuncRequest const &) const;
257 /// Add the menu item unconditionally
258 void add(MenuItem const & item) { items_.push_back(item); }
259 /// Checks the associated FuncRequest status before adding the
261 void addWithStatusCheck(MenuItem const &);
262 // Check whether the menu shortcuts are unique
263 void checkShortcuts() const;
265 void expandLastfiles();
266 void expandDocuments();
267 void expandBookmarks();
268 void expandFormats(MenuItem::Kind kind, Buffer const * buf);
269 void expandFloatListInsert(Buffer const * buf);
270 void expandFloatInsert(Buffer const * buf);
271 void expandFlexInsert(Buffer const * buf, std::string s);
272 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth);
273 void expandToc(Buffer const * buf);
274 void expandPasteRecent();
275 void expandToolbars();
276 void expandBranches(Buffer const * buf);
284 class GuiPopupMenu : public GuiPopupMenuBase
288 GuiPopupMenu(GuiView * gv, MenuItem const & mi, bool top_level)
289 : GuiPopupMenuBase(gv), top_level_menu(top_level? new Menu : 0),
290 view(gv), name(mi.submenuname())
296 GuiPopupMenu(GuiView * gv, QString const & name_, bool top_level)
297 : GuiPopupMenuBase(gv), top_level_menu(top_level? new Menu : 0), view(gv),
303 ~GuiPopupMenu() { delete top_level_menu; }
305 /// populates the menu or one of its submenu
306 /// This is used as a recursive function
307 void populate(QMenu * qMenu, Menu * menu);
309 /// Get a Menu item label from the menu backend
310 QString label(MenuItem const & mi) const;
312 /// Only needed for top level menus.
313 Menu * top_level_menu;
316 /// the name of this menu
324 guiApp->menus().updateMenu(name);
328 /// Helper for std::find_if
332 MenuNamesEqual(QString const & name) : name_(name) {}
333 bool operator()(Menu const & menu) const { return menu.name() == name_; }
340 typedef std::vector<Menu> MenuList;
342 typedef MenuList::const_iterator const_iterator;
344 typedef MenuList::iterator iterator;
346 /////////////////////////////////////////////////////////////////////
347 // GuiPopupMenu implementation
348 /////////////////////////////////////////////////////////////////////
350 void GuiPopupMenu::populate(QMenu * qMenu, Menu * menu)
352 LYXERR(Debug::GUI, "populating menu " << fromqstr(menu->name()));
353 if (menu->size() == 0) {
354 LYXERR(Debug::GUI, "\tERROR: empty menu " << fromqstr(menu->name()));
357 LYXERR(Debug::GUI, " ***** menu entries " << menu->size());
358 Menu::const_iterator m = menu->begin();
359 Menu::const_iterator end = menu->end();
360 for (; m != end; ++m) {
361 if (m->kind() == MenuItem::Separator)
362 qMenu->addSeparator();
363 else if (m->kind() == MenuItem::Submenu) {
364 QMenu * subMenu = qMenu->addMenu(label(*m));
365 populate(subMenu, m->submenu());
367 // we have a MenuItem::Command
368 qMenu->addAction(new Action(*view, QIcon(), label(*m), m->func(),
375 QString GuiPopupMenu::label(MenuItem const & mi) const
377 QString label = mi.label();
378 label.replace("&", "&&");
380 QString shortcut = mi.shortcut();
381 if (!shortcut.isEmpty()) {
382 int pos = label.indexOf(shortcut);
384 //label.insert(pos, 1, char_type('&'));
385 label.replace(pos, 0, "&");
388 QString const binding = mi.binding();
389 if (!binding.isEmpty())
390 label += '\t' + binding;
395 /////////////////////////////////////////////////////////////////////
396 // Menu implementation
397 /////////////////////////////////////////////////////////////////////
399 void Menu::addWithStatusCheck(MenuItem const & i)
403 case MenuItem::Command: {
404 FuncStatus status = lyx::getStatus(i.func());
405 if (status.unknown() || (!status.enabled() && i.optional()))
408 items_.back().status(status);
412 case MenuItem::Submenu: {
414 bool enabled = false;
415 for (const_iterator cit = i.submenu()->begin();
416 cit != i.submenu()->end(); ++cit) {
417 if ((cit->kind() == MenuItem::Command
418 || cit->kind() == MenuItem::Submenu)
419 && cit->status().enabled()) {
424 if (enabled || !i.optional()) {
426 items_.back().status().enabled(enabled);
434 case MenuItem::Separator:
435 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
445 void Menu::read(Lexer & lex)
473 struct keyword_item menutags[md_last - 1] = {
474 { "bookmarks", md_bookmarks },
475 { "branches", md_branches },
476 { "charstyles", md_charstyles },
477 { "custom", md_custom },
478 { "documents", md_documents },
479 { "elements", md_elements },
480 { "end", md_endmenu },
481 { "exportformats", md_exportformats },
482 { "floatinsert", md_floatinsert },
483 { "floatlistinsert", md_floatlistinsert },
484 { "importformats", md_importformats },
486 { "lastfiles", md_lastfiles },
487 { "optitem", md_optitem },
488 { "optsubmenu", md_optsubmenu },
489 { "pasterecent", md_pasterecent },
490 { "separator", md_separator },
491 { "submenu", md_submenu },
493 { "toolbars", md_toolbars },
494 { "updateformats", md_updateformats },
495 { "viewformats", md_viewformats }
498 lex.pushTable(menutags, md_last - 1);
499 if (lyxerr.debugging(Debug::PARSER))
500 lex.printTable(lyxerr);
503 bool optional = false;
505 while (lex.isOK() && !quit) {
509 // fallback to md_item
512 docstring const name = translateIfPossible(lex.getDocString());
514 string const command = lex.getString();
515 FuncRequest func = lyxaction.lookupFunc(command);
516 add(MenuItem(MenuItem::Command, toqstr(name), func, optional));
522 add(MenuItem(MenuItem::Separator));
526 add(MenuItem(MenuItem::Lastfiles));
530 add(MenuItem(MenuItem::CharStyles));
534 add(MenuItem(MenuItem::Custom));
538 add(MenuItem(MenuItem::Elements));
542 add(MenuItem(MenuItem::Documents));
546 add(MenuItem(MenuItem::Bookmarks));
550 add(MenuItem(MenuItem::Toc));
554 add(MenuItem(MenuItem::ViewFormats));
557 case md_updateformats:
558 add(MenuItem(MenuItem::UpdateFormats));
561 case md_exportformats:
562 add(MenuItem(MenuItem::ExportFormats));
565 case md_importformats:
566 add(MenuItem(MenuItem::ImportFormats));
569 case md_floatlistinsert:
570 add(MenuItem(MenuItem::FloatListInsert));
574 add(MenuItem(MenuItem::FloatInsert));
578 add(MenuItem(MenuItem::PasteRecent));
582 add(MenuItem(MenuItem::Toolbars));
586 add(MenuItem(MenuItem::Branches));
591 // fallback to md_submenu
594 docstring const mlabel = translateIfPossible(lex.getDocString());
596 docstring const mname = lex.getDocString();
597 add(MenuItem(MenuItem::Submenu,
598 toqstr(mlabel), toqstr(mname), optional));
608 lex.printError("Menu::read: "
609 "Unknown menu tag: `$$Token'");
617 MenuItem const & Menu::operator[](size_type i) const
623 bool Menu::hasFunc(FuncRequest const & func) const
625 for (const_iterator it = begin(), et = end(); it != et; ++it)
626 if (it->func() == func)
632 void Menu::checkShortcuts() const
634 // This is a quadratic algorithm, but we do not care because
635 // menus are short enough
636 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
637 QString shortcut = it1->shortcut();
638 if (shortcut.isEmpty())
640 if (!it1->label().contains(shortcut))
641 lyxerr << "Menu warning: menu entry \""
642 << fromqstr(it1->label())
643 << "\" does not contain shortcut `"
644 << fromqstr(shortcut) << "'." << endl;
645 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
646 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
647 lyxerr << "Menu warning: menu entries "
648 << '"' << fromqstr(it1->fulllabel())
649 << "\" and \"" << fromqstr(it2->fulllabel())
650 << "\" share the same shortcut."
658 bool Menu::searchMenu(FuncRequest const & func, vector<docstring> & names) const
660 const_iterator m = begin();
661 const_iterator m_end = end();
662 for (; m != m_end; ++m) {
663 if (m->kind() == MenuItem::Command && m->func() == func) {
664 names.push_back(qstring_to_ucs4(m->label()));
667 if (m->kind() == MenuItem::Submenu) {
668 names.push_back(qstring_to_ucs4(m->label()));
669 Menu const & submenu = *m->submenu();
670 if (submenu.searchMenu(func, names))
679 bool compareFormat(Format const * p1, Format const * p2)
685 QString limitStringLength(docstring const & str)
687 size_t const max_item_length = 45;
689 if (str.size() > max_item_length)
690 return toqstr(str.substr(0, max_item_length - 3) + "...");
696 void Menu::expandLastfiles()
698 LastFilesSection::LastFiles const & lf = LyX::cref().session().lastFiles().lastFiles();
699 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
703 for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
704 string const file = lfit->absFilename();
705 QString const label = QString("%1. %2|%3").arg(ii)
706 .arg(toqstr(makeDisplayPath(file, 30))).arg(ii);
707 add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
712 void Menu::expandDocuments()
714 Buffer * first = theBufferList().first();
719 // We cannot use a for loop as the buffer list cycles.
721 QString label = toqstr(b->fileName().displayName(20));
725 label = QString::number(ii) + ". " + label + '|' + QString::number(ii);
726 add(MenuItem(MenuItem::Command, label,
727 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
729 b = theBufferList().next(b);
731 } while (b != first);
733 add(MenuItem(MenuItem::Command, qt_("No Documents Open!"),
734 FuncRequest(LFUN_NOACTION)));
739 void Menu::expandBookmarks()
741 lyx::BookmarksSection const & bm = LyX::cref().session().bookmarks();
743 for (size_t i = 1; i <= bm.size(); ++i) {
745 string const file = bm.bookmark(i).filename.absFilename();
746 QString const label = QString("%1. %2|%3").arg(i)
747 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
748 add(MenuItem(MenuItem::Command, label,
749 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
755 void Menu::expandFormats(MenuItem::Kind kind, Buffer const * buf)
757 if (!buf && kind != MenuItem::ImportFormats) {
758 add(MenuItem(MenuItem::Command,
759 qt_("No Document Open!"),
760 FuncRequest(LFUN_NOACTION)));
764 typedef vector<Format const *> Formats;
769 case MenuItem::ImportFormats:
770 formats = theConverters().importableFormats();
771 action = LFUN_BUFFER_IMPORT;
773 case MenuItem::ViewFormats:
774 formats = buf->exportableFormats(true);
775 action = LFUN_BUFFER_VIEW;
777 case MenuItem::UpdateFormats:
778 formats = buf->exportableFormats(true);
779 action = LFUN_BUFFER_UPDATE;
782 formats = buf->exportableFormats(false);
783 action = LFUN_BUFFER_EXPORT;
785 sort(formats.begin(), formats.end(), &compareFormat);
787 Formats::const_iterator fit = formats.begin();
788 Formats::const_iterator end = formats.end();
789 for (; fit != end ; ++fit) {
792 QString label = toqstr((*fit)->prettyname());
793 QString const shortcut = toqstr((*fit)->shortcut());
796 case MenuItem::ImportFormats:
797 // FIXME: This is a hack, we should rather solve
798 // FIXME: bug 2488 instead.
799 if ((*fit)->name() == "text")
800 label = qt_("Plain Text");
801 else if ((*fit)->name() == "textparagraph")
802 label = qt_("Plain Text, Join Lines");
805 case MenuItem::ViewFormats:
806 case MenuItem::ExportFormats:
807 case MenuItem::UpdateFormats:
808 if (!(*fit)->documentFormat())
815 // FIXME: if we had proper support for translating the
816 // format names defined in configure.py, there would
817 // not be a need to check whether the shortcut is
818 // correct. If we add it uncondiitonally, it would
819 // create useless warnings on bad shortcuts
820 if (!shortcut.isEmpty() && label.contains(shortcut))
821 label += '|' + shortcut;
824 addWithStatusCheck(MenuItem(MenuItem::Command, label,
825 FuncRequest(action, (*fit)->name())));
827 add(MenuItem(MenuItem::Command, label,
828 FuncRequest(action, (*fit)->name())));
833 void Menu::expandFloatListInsert(Buffer const * buf)
836 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
837 FuncRequest(LFUN_NOACTION)));
841 FloatList const & floats = buf->params().documentClass().floats();
842 FloatList::const_iterator cit = floats.begin();
843 FloatList::const_iterator end = floats.end();
844 for (; cit != end; ++cit) {
845 addWithStatusCheck(MenuItem(MenuItem::Command,
846 qt_(cit->second.listName()),
847 FuncRequest(LFUN_FLOAT_LIST,
848 cit->second.type())));
853 void Menu::expandFloatInsert(Buffer const * buf)
856 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
857 FuncRequest(LFUN_NOACTION)));
861 FloatList const & floats = buf->params().documentClass().floats();
862 FloatList::const_iterator cit = floats.begin();
863 FloatList::const_iterator end = floats.end();
864 for (; cit != end; ++cit) {
866 QString const label = qt_(cit->second.name());
867 addWithStatusCheck(MenuItem(MenuItem::Command, label,
868 FuncRequest(LFUN_FLOAT_INSERT,
869 cit->second.type())));
874 void Menu::expandFlexInsert(Buffer const * buf, string s)
877 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
878 FuncRequest(LFUN_NOACTION)));
881 TextClass::InsetLayouts const & insetLayouts =
882 buf->params().documentClass().insetLayouts();
883 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
884 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
885 for (; cit != end; ++cit) {
886 docstring const label = cit->first;
887 if (cit->second.lyxtype() == s)
888 addWithStatusCheck(MenuItem(MenuItem::Command,
889 toqstr(label), FuncRequest(LFUN_FLEX_INSERT,
895 size_t const max_number_of_items = 25;
897 void Menu::expandToc2(Toc const & toc_list,
898 size_t from, size_t to, int depth)
900 int shortcut_count = 0;
902 // check whether depth is smaller than the smallest depth in toc.
903 int min_depth = 1000;
904 for (size_t i = from; i < to; ++i)
905 min_depth = min(min_depth, toc_list[i].depth());
906 if (min_depth > depth)
909 if (to - from <= max_number_of_items) {
910 for (size_t i = from; i < to; ++i) {
911 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
912 label += limitStringLength(toc_list[i].str());
913 if (toc_list[i].depth() == depth
914 && shortcut_count < 9) {
915 if (label.contains(QString::number(shortcut_count + 1)))
916 label += '|' + QString::number(++shortcut_count);
918 add(MenuItem(MenuItem::Command, label,
919 FuncRequest(toc_list[i].action())));
924 size_t new_pos = pos + 1;
925 while (new_pos < to &&
926 toc_list[new_pos].depth() > depth)
929 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
930 label += limitStringLength(toc_list[pos].str());
931 if (toc_list[pos].depth() == depth &&
932 shortcut_count < 9) {
933 if (label.contains(QString::number(shortcut_count + 1)))
934 label += '|' + QString::number(++shortcut_count);
936 if (new_pos == pos + 1) {
937 add(MenuItem(MenuItem::Command,
938 label, FuncRequest(toc_list[pos].action())));
940 MenuItem item(MenuItem::Submenu, label);
941 item.setSubmenu(new Menu);
942 item.submenu()->expandToc2(toc_list, pos, new_pos, depth + 1);
951 void Menu::expandToc(Buffer const * buf)
953 // To make things very cleanly, we would have to pass buf to
954 // all MenuItem constructors and to expandToc2. However, we
955 // know that all the entries in a TOC will be have status_ ==
956 // OK, so we avoid this unnecessary overhead (JMarc)
959 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
960 FuncRequest(LFUN_NOACTION)));
964 Buffer* cbuf = const_cast<Buffer*>(buf);
965 cbuf->tocBackend().update();
966 cbuf->structureChanged();
968 // Add an entry for the master doc if this is a child doc
969 Buffer const * const master = buf->masterBuffer();
971 ParIterator const pit = par_iterator_begin(master->inset());
972 string const arg = convert<string>(pit->id());
973 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
974 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
977 FloatList const & floatlist = buf->params().documentClass().floats();
978 TocList const & toc_list = buf->tocBackend().tocs();
979 TocList::const_iterator cit = toc_list.begin();
980 TocList::const_iterator end = toc_list.end();
981 for (; cit != end; ++cit) {
983 if (cit->first == "tableofcontents")
986 // All the rest is for floats
987 Menu * submenu = new Menu;
988 TocIterator ccit = cit->second.begin();
989 TocIterator eend = cit->second.end();
990 for (; ccit != eend; ++ccit) {
991 QString const label = limitStringLength(ccit->str());
992 submenu->add(MenuItem(MenuItem::Command, label,
993 FuncRequest(ccit->action())));
995 string const & floatName = floatlist.getType(cit->first).listName();
997 if (!floatName.empty())
998 label = qt_(floatName);
999 // BUG3633: listings is not a proper float so its name
1000 // is not shown in floatlist.
1001 else if (cit->first == "equation")
1002 label = qt_("List of Equations");
1003 else if (cit->first == "index")
1004 label = qt_("List of Indexes");
1005 else if (cit->first == "listing")
1006 label = qt_("List of Listings");
1007 else if (cit->first == "marginalnote")
1008 label = qt_("List of Marginal notes");
1009 else if (cit->first == "note")
1010 label = qt_("List of Notes");
1011 else if (cit->first == "footnote")
1012 label = qt_("List of Foot notes");
1013 else if (cit->first == "label")
1014 label = qt_("Labels and References");
1015 else if (cit->first == "citation")
1016 label = qt_("List of Citations");
1017 // this should not happen now, but if something else like
1018 // listings is added later, this can avoid an empty menu name.
1020 label = qt_("Other floats");
1021 MenuItem item(MenuItem::Submenu, label);
1022 item.setSubmenu(submenu);
1026 // Handle normal TOC
1027 cit = toc_list.find("tableofcontents");
1029 addWithStatusCheck(MenuItem(MenuItem::Command,
1030 qt_("No Table of contents"),
1033 expandToc2(cit->second, 0, cit->second.size(), 0);
1038 void Menu::expandPasteRecent()
1040 vector<docstring> const sel = cap::availableSelections();
1042 vector<docstring>::const_iterator cit = sel.begin();
1043 vector<docstring>::const_iterator end = sel.end();
1045 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1046 add(MenuItem(MenuItem::Command, toqstr(*cit),
1047 FuncRequest(LFUN_PASTE, convert<string>(index))));
1052 void Menu::expandToolbars()
1055 // extracts the toolbars from the backend
1056 ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
1057 ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
1059 for (; cit != end; ++cit) {
1060 QString label = qt_(cit->gui_name);
1061 // frontends are not supposed to turn on/off toolbars,
1062 // if they cannot update ToolbarBackend::flags. That
1063 // is to say, ToolbarsBackend::flags should reflect
1064 // the true state of toolbars.
1066 // menu is displayed as
1070 // in the case of auto.
1071 if (cit->flags & ToolbarInfo::AUTO)
1072 label += qt_(" (auto)");
1073 add(MenuItem(MenuItem::Command, label,
1074 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name + " allowauto")));
1079 void Menu::expandBranches(Buffer const * buf)
1082 add(MenuItem(MenuItem::Command,
1083 qt_("No Document Open!"),
1084 FuncRequest(LFUN_NOACTION)));
1088 BufferParams const & params = buf->masterBuffer()->params();
1089 if (params.branchlist().empty()) {
1090 add(MenuItem(MenuItem::Command,
1091 qt_("No Branch in Document!"),
1092 FuncRequest(LFUN_NOACTION)));
1096 BranchList::const_iterator cit = params.branchlist().begin();
1097 BranchList::const_iterator end = params.branchlist().end();
1099 for (int ii = 1; cit != end; ++cit, ++ii) {
1100 docstring label = cit->getBranch();
1102 label = convert<docstring>(ii) + ". " + label + char_type('|') + convert<docstring>(ii);
1103 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1104 FuncRequest(LFUN_BRANCH_INSERT,
1105 cit->getBranch())));
1112 struct Menus::Impl {
1114 bool hasMenu(QString const &) const;
1116 Menu & getMenu(QString const &);
1118 Menu const & getMenu(QString const &) const;
1120 /// Expands some special entries of the menu
1121 /** The entries with the following kind are expanded to a
1122 sequence of Command MenuItems: Lastfiles, Documents,
1123 ViewFormats, ExportFormats, UpdateFormats, Branches
1125 void expand(Menu const & frommenu, Menu & tomenu,
1126 Buffer const *) const;
1128 /// Initialize specific MACOS X menubar
1129 void macxMenuBarInit(GuiView * view);
1131 /// Mac special menu.
1132 /** This defines a menu whose entries list the FuncRequests
1133 that will be removed by expand() in other menus. This is
1134 used by the Qt/Mac code
1143 typedef QHash<QString, GuiPopupMenu *> NameMap;
1145 /// name to menu for \c menu() method.
1150 /////////////////////////////////////////////////////////////////////
1151 // Menus::Impl implementation
1152 /////////////////////////////////////////////////////////////////////
1155 Here is what the Qt documentation says about how a menubar is chosen:
1157 1) If the window has a QMenuBar then it is used. 2) If the window
1158 is a modal then its menubar is used. If no menubar is specified
1159 then a default menubar is used (as documented below) 3) If the
1160 window has no parent then the default menubar is used (as
1163 The above 3 steps are applied all the way up the parent window
1164 chain until one of the above are satisifed. If all else fails a
1165 default menubar will be created, the default menubar on Qt/Mac is
1166 an empty menubar, however you can create a different default
1167 menubar by creating a parentless QMenuBar, the first one created
1168 will thus be designated the default menubar, and will be used
1169 whenever a default menubar is needed.
1171 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1172 that this menubar will be used also when one of LyX' dialogs has
1175 void Menus::Impl::macxMenuBarInit(GuiView * view)
1177 // The Mac menubar initialisation must be done only once!
1178 static bool done = false;
1183 /* Since Qt 4.2, the qt/mac menu code has special code for
1184 specifying the role of a menu entry. However, it does not
1185 work very well with our scheme of creating menus on demand,
1186 and therefore we need to put these entries in a special
1187 invisible menu. (JMarc)
1190 /* The entries of our special mac menu. If we add support for
1191 * special entries in Menus, we could imagine something
1193 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
1194 * and therefore avoid hardcoding. I am not sure it is worth
1195 * the hassle, though. (JMarc)
1197 struct MacMenuEntry {
1201 QAction::MenuRole role;
1204 MacMenuEntry entries[] = {
1205 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1206 QAction::AboutRole},
1207 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1208 QAction::PreferencesRole},
1209 {LFUN_RECONFIGURE, "", "Reconfigure",
1210 QAction::ApplicationSpecificRole},
1211 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1213 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1215 // the special menu for Menus.
1216 for (size_t i = 0 ; i < num_entries ; ++i) {
1217 FuncRequest const func(entries[i].action,
1218 from_utf8(entries[i].arg));
1219 specialmenu_.add(MenuItem(MenuItem::Command, entries[i].label, func));
1222 // add the entries to a QMenu that will eventually be empty
1223 // and therefore invisible.
1224 QMenu * qMenu = view->menuBar()->addMenu("special");
1225 Menu::const_iterator cit = specialmenu_.begin();
1226 Menu::const_iterator end = specialmenu_.end();
1227 for (size_t i = 0 ; cit != end ; ++cit, ++i) {
1228 Action * action = new Action(*view, QIcon(), cit->label(),
1229 cit->func(), QString());
1230 action->setMenuRole(entries[i].role);
1231 qMenu->addAction(action);
1236 void Menus::Impl::expand(Menu const & frommenu, Menu & tomenu,
1237 Buffer const * buf) const
1239 if (!tomenu.empty())
1242 for (Menu::const_iterator cit = frommenu.begin();
1243 cit != frommenu.end() ; ++cit) {
1244 switch (cit->kind()) {
1245 case MenuItem::Lastfiles:
1246 tomenu.expandLastfiles();
1249 case MenuItem::Documents:
1250 tomenu.expandDocuments();
1253 case MenuItem::Bookmarks:
1254 tomenu.expandBookmarks();
1257 case MenuItem::ImportFormats:
1258 case MenuItem::ViewFormats:
1259 case MenuItem::UpdateFormats:
1260 case MenuItem::ExportFormats:
1261 tomenu.expandFormats(cit->kind(), buf);
1264 case MenuItem::CharStyles:
1265 tomenu.expandFlexInsert(buf, "charstyle");
1268 case MenuItem::Custom:
1269 tomenu.expandFlexInsert(buf, "custom");
1272 case MenuItem::Elements:
1273 tomenu.expandFlexInsert(buf, "element");
1276 case MenuItem::FloatListInsert:
1277 tomenu.expandFloatListInsert(buf);
1280 case MenuItem::FloatInsert:
1281 tomenu.expandFloatInsert(buf);
1284 case MenuItem::PasteRecent:
1285 tomenu.expandPasteRecent();
1288 case MenuItem::Toolbars:
1289 tomenu.expandToolbars();
1292 case MenuItem::Branches:
1293 tomenu.expandBranches(buf);
1297 tomenu.expandToc(buf);
1300 case MenuItem::Submenu: {
1301 MenuItem item(*cit);
1302 item.setSubmenu(new Menu(cit->submenuname()));
1303 expand(getMenu(cit->submenuname()), *item.submenu(), buf);
1304 tomenu.addWithStatusCheck(item);
1308 case MenuItem::Separator:
1309 tomenu.addWithStatusCheck(*cit);
1312 case MenuItem::Command:
1313 if (!specialmenu_.hasFunc(cit->func()))
1314 tomenu.addWithStatusCheck(*cit);
1318 // we do not want the menu to end with a separator
1319 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
1320 tomenu.items_.pop_back();
1322 // Check whether the shortcuts are unique
1323 tomenu.checkShortcuts();
1327 bool Menus::Impl::hasMenu(QString const & name) const
1329 return find_if(menulist_.begin(), menulist_.end(),
1330 MenuNamesEqual(name)) != menulist_.end();
1334 Menu const & Menus::Impl::getMenu(QString const & name) const
1336 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
1337 MenuNamesEqual(name));
1338 if (cit == menulist_.end())
1339 lyxerr << "No submenu named " << fromqstr(name) << endl;
1340 BOOST_ASSERT(cit != menulist_.end());
1345 Menu & Menus::Impl::getMenu(QString const & name)
1347 iterator it = find_if(menulist_.begin(), menulist_.end(),
1348 MenuNamesEqual(name));
1349 if (it == menulist_.end())
1350 lyxerr << "No submenu named " << fromqstr(name) << endl;
1351 BOOST_ASSERT(it != menulist_.end());
1355 /////////////////////////////////////////////////////////////////////
1356 // Menus implementation
1357 /////////////////////////////////////////////////////////////////////
1359 Menus::Menus(): d(new Impl) {}
1362 void Menus::read(Lexer & lex)
1371 struct keyword_item menutags[md_last - 1] = {
1372 { "end", md_endmenuset },
1373 { "menu", md_menu },
1374 { "menubar", md_menubar }
1378 if (compare_ascii_no_case(lex.getString(), "menuset")) {
1379 lyxerr << "Menubackend::read: ERROR wrong token:`"
1380 << lex.getString() << '\'' << endl;
1383 lex.pushTable(menutags, md_last - 1);
1384 if (lyxerr.debugging(Debug::PARSER))
1385 lex.printTable(lyxerr);
1389 while (lex.isOK() && !quit) {
1390 switch (lex.lex()) {
1392 d->menubar_.read(lex);
1396 QString const name = toqstr(lex.getDocString());
1397 if (d->hasMenu(name))
1398 d->getMenu(name).read(lex);
1402 d->menulist_.push_back(menu);
1410 lex.printError("menubackend::read: "
1411 "Unknown menu tag: `$$Token'");
1419 bool Menus::searchMenu(FuncRequest const & func,
1420 vector<docstring> & names) const
1422 return d->menubar_.searchMenu(func, names);
1426 void Menus::fillMenuBar(GuiView * view)
1428 // Clear all menubar contents before filling it.
1429 view->menuBar()->clear();
1432 // setup special mac specific menu item
1433 d->macxMenuBarInit(view);
1436 LYXERR(Debug::GUI, "populating menu bar" << fromqstr(d->menubar_.name()));
1438 if (d->menubar_.size() == 0) {
1439 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
1440 << fromqstr(d->menubar_.name()));
1444 LYXERR(Debug::GUI, "menu bar entries "
1445 << d->menubar_.size());
1449 d->expand(d->menubar_, menu, view->buffer());
1451 Menu::const_iterator m = menu.begin();
1452 Menu::const_iterator end = menu.end();
1454 for (; m != end; ++m) {
1456 if (m->kind() != MenuItem::Submenu) {
1457 LYXERR(Debug::GUI, "\tERROR: not a submenu " << fromqstr(m->label()));
1461 LYXERR(Debug::GUI, "menu bar item " << fromqstr(m->label())
1462 << " is a submenu named " << fromqstr(m->submenuname()));
1464 QString name = m->submenuname();
1465 if (!d->hasMenu(name)) {
1466 LYXERR(Debug::GUI, "\tERROR: " << fromqstr(name)
1467 << " submenu has no menu!");
1471 GuiPopupMenu * qmenu = new GuiPopupMenu(view, *m, true);
1472 view->menuBar()->addMenu(qmenu);
1474 d->name_map_[name] = qmenu;
1479 void Menus::updateMenu(QString const & name)
1481 GuiPopupMenu * qmenu = d->name_map_[name];
1482 LYXERR(Debug::GUI, "GuiPopupMenu::updateView()"
1483 << "\tTriggered menu: " << fromqstr(qmenu->name));
1486 if (qmenu->name.isEmpty())
1489 // Here, We make sure that theLyXFunc points to the correct LyXView.
1490 theLyXFunc().setLyXView(qmenu->view);
1492 if (!d->hasMenu(qmenu->name)) {
1493 qmenu->addAction(qt_("No action defined!"));
1494 LYXERR(Debug::GUI, "\tWARNING: non existing menu: "
1495 << fromqstr(qmenu->name));
1499 Menu const & fromLyxMenu = d->getMenu(qmenu->name);
1500 d->expand(fromLyxMenu, *qmenu->top_level_menu, qmenu->view->buffer());
1501 qmenu->populate(qmenu, qmenu->top_level_menu);
1505 QMenu * Menus::menu(QString const & name, GuiView & view)
1507 LYXERR(Debug::GUI, "Context menu requested: " << fromqstr(name));
1508 GuiPopupMenu * menu = d->name_map_.value(name, 0);
1509 if (!menu && !name.startsWith("context-")) {
1510 LYXERR0("resquested context menu not found: " << fromqstr(name));
1514 menu = new GuiPopupMenu(&view, name, true);
1515 d->name_map_[name] = menu;
1519 } // namespace frontend
1522 #include "Menus_moc.cpp"