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 "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;
157 /// The label of a given menuitem
158 QString label() const { return label_.split('|')[0]; }
160 /// The keyboard shortcut (usually underlined in the entry)
161 QString shortcut() const
163 return label_.contains('|') ? label_.split('|')[1] : QString();
165 /// The complete label, with label and shortcut separated by a '|'
166 QString fulllabel() const { return label_;}
167 /// The kind of entry
168 Kind kind() const { return kind_; }
169 /// the action (if relevant)
170 FuncRequest const & func() const { return func_; }
171 /// returns true if the entry should be ommited when disabled
172 bool optional() const { return optional_; }
173 /// returns the status of the lfun associated with this entry
174 FuncStatus const & status() const { return status_; }
175 /// returns the status of the lfun associated with this entry
176 FuncStatus & status() { return status_; }
177 /// returns the status of the lfun associated with this entry
178 void status(FuncStatus const & status) { status_ = status; }
180 ///returns the binding associated to this action.
181 QString binding() const
183 if (kind_ != Command)
185 // Get the keys bound to this action, but keep only the
187 KeyMap::Bindings bindings = theTopLevelKeymap().findBindings(func_);
189 return toqstr(bindings.begin()->print(KeySequence::ForGui));
191 LYXERR(Debug::KBMAP, "No binding for "
192 << lyxaction.getActionName(func_.action)
193 << '(' << func_.argument() << ')');
197 /// the description of the submenu (if relevant)
198 QString const & submenuname() const { return submenuname_; }
199 /// set the description of the submenu
200 void submenuname(QString const & name) { submenuname_ = name; }
202 Menu * submenu() const { return submenu_.get(); }
204 void setSubmenu(Menu * menu) { submenu_.reset(menu); }
214 QString submenuname_;
220 boost::shared_ptr<Menu> submenu_;
227 typedef std::vector<MenuItem> ItemList;
229 typedef ItemList::const_iterator const_iterator;
231 explicit Menu(QString const & name = QString()) : name_(name) {}
236 QString const & name() const { return name_; }
238 bool empty() const { return items_.empty(); }
239 /// Clear the menu content.
240 void clear() { items_.clear(); }
242 size_t size() const { return items_.size(); }
244 MenuItem const & operator[](size_t) const;
246 const_iterator begin() const { return items_.begin(); }
248 const_iterator end() const { return items_.end(); }
250 // search for func in this menu iteratively, and put menu
252 bool searchMenu(FuncRequest const & func, std::vector<docstring> & names)
255 bool hasFunc(FuncRequest const &) const;
256 /// Add the menu item unconditionally
257 void add(MenuItem const & item) { items_.push_back(item); }
258 /// Checks the associated FuncRequest status before adding the
260 void addWithStatusCheck(MenuItem const &);
261 // Check whether the menu shortcuts are unique
262 void checkShortcuts() const;
264 void expandLastfiles();
265 void expandDocuments();
266 void expandBookmarks();
267 void expandFormats(MenuItem::Kind kind, Buffer const * buf);
268 void expandFloatListInsert(Buffer const * buf);
269 void expandFloatInsert(Buffer const * buf);
270 void expandFlexInsert(Buffer const * buf, std::string s);
271 void expandToc2(Toc const & toc_list, size_t from, size_t to, int depth);
272 void expandToc(Buffer const * buf);
273 void expandPasteRecent();
274 void expandToolbars();
275 void expandBranches(Buffer const * buf);
283 class GuiPopupMenu : public QMenu
287 GuiPopupMenu(GuiView * gv, MenuItem const & mi, bool top_level)
288 : QMenu(gv), top_level_menu(top_level? new Menu : 0), view(gv),
289 name(mi.submenuname())
294 ~GuiPopupMenu() { delete top_level_menu; }
296 /// populates the menu or one of its submenu
297 /// This is used as a recursive function
298 void populate(QMenu * qMenu, Menu * menu);
300 /// Get a Menu item label from the menu backend
301 QString label(MenuItem const & mi) const;
303 void showEvent(QShowEvent * ev)
306 guiApp->menus().updateMenu(name);
307 QMenu::showEvent(ev);
310 /// Only needed for top level menus.
311 Menu * top_level_menu;
314 /// the name of this menu
318 /// Helper for std::find_if
322 MenuNamesEqual(QString const & name) : name_(name) {}
323 bool operator()(Menu const & menu) const { return menu.name() == name_; }
330 typedef std::vector<Menu> MenuList;
332 typedef MenuList::const_iterator const_iterator;
334 typedef MenuList::iterator iterator;
336 /////////////////////////////////////////////////////////////////////
337 // GuiPopupMenu implementation
338 /////////////////////////////////////////////////////////////////////
340 void GuiPopupMenu::populate(QMenu * qMenu, Menu * menu)
342 LYXERR(Debug::GUI, "populating menu " << fromqstr(menu->name()));
343 if (menu->size() == 0) {
344 LYXERR(Debug::GUI, "\tERROR: empty menu " << fromqstr(menu->name()));
347 LYXERR(Debug::GUI, " ***** menu entries " << menu->size());
348 Menu::const_iterator m = menu->begin();
349 Menu::const_iterator end = menu->end();
350 for (; m != end; ++m) {
351 if (m->kind() == MenuItem::Separator)
352 qMenu->addSeparator();
353 else if (m->kind() == MenuItem::Submenu) {
354 QMenu * subMenu = qMenu->addMenu(label(*m));
355 populate(subMenu, m->submenu());
357 // we have a MenuItem::Command
358 qMenu->addAction(new Action(*view, QIcon(), label(*m), m->func(),
365 QString GuiPopupMenu::label(MenuItem const & mi) const
367 QString label = mi.label();
368 label.replace("&", "&&");
370 QString shortcut = mi.shortcut();
371 if (!shortcut.isEmpty()) {
372 int pos = label.indexOf(shortcut);
374 //label.insert(pos, 1, char_type('&'));
375 label.replace(pos, 0, "&");
378 QString const binding = mi.binding();
379 if (!binding.isEmpty())
380 label += '\t' + binding;
385 /////////////////////////////////////////////////////////////////////
386 // Menu implementation
387 /////////////////////////////////////////////////////////////////////
389 void Menu::addWithStatusCheck(MenuItem const & i)
393 case MenuItem::Command: {
394 FuncStatus status = lyx::getStatus(i.func());
395 if (status.unknown() || (!status.enabled() && i.optional()))
398 items_.back().status(status);
402 case MenuItem::Submenu: {
404 bool enabled = false;
405 for (const_iterator cit = i.submenu()->begin();
406 cit != i.submenu()->end(); ++cit) {
407 if ((cit->kind() == MenuItem::Command
408 || cit->kind() == MenuItem::Submenu)
409 && cit->status().enabled()) {
414 if (enabled || !i.optional()) {
416 items_.back().status().enabled(enabled);
424 case MenuItem::Separator:
425 if (!items_.empty() && items_.back().kind() != MenuItem::Separator)
435 void Menu::read(Lexer & lex)
463 struct keyword_item menutags[md_last - 1] = {
464 { "bookmarks", md_bookmarks },
465 { "branches", md_branches },
466 { "charstyles", md_charstyles },
467 { "custom", md_custom },
468 { "documents", md_documents },
469 { "elements", md_elements },
470 { "end", md_endmenu },
471 { "exportformats", md_exportformats },
472 { "floatinsert", md_floatinsert },
473 { "floatlistinsert", md_floatlistinsert },
474 { "importformats", md_importformats },
476 { "lastfiles", md_lastfiles },
477 { "optitem", md_optitem },
478 { "optsubmenu", md_optsubmenu },
479 { "pasterecent", md_pasterecent },
480 { "separator", md_separator },
481 { "submenu", md_submenu },
483 { "toolbars", md_toolbars },
484 { "updateformats", md_updateformats },
485 { "viewformats", md_viewformats }
488 lex.pushTable(menutags, md_last - 1);
489 if (lyxerr.debugging(Debug::PARSER))
490 lex.printTable(lyxerr);
493 bool optional = false;
495 while (lex.isOK() && !quit) {
499 // fallback to md_item
502 docstring const name = translateIfPossible(lex.getDocString());
504 string const command = lex.getString();
505 FuncRequest func = lyxaction.lookupFunc(command);
506 add(MenuItem(MenuItem::Command, toqstr(name), func, optional));
512 add(MenuItem(MenuItem::Separator));
516 add(MenuItem(MenuItem::Lastfiles));
520 add(MenuItem(MenuItem::CharStyles));
524 add(MenuItem(MenuItem::Custom));
528 add(MenuItem(MenuItem::Elements));
532 add(MenuItem(MenuItem::Documents));
536 add(MenuItem(MenuItem::Bookmarks));
540 add(MenuItem(MenuItem::Toc));
544 add(MenuItem(MenuItem::ViewFormats));
547 case md_updateformats:
548 add(MenuItem(MenuItem::UpdateFormats));
551 case md_exportformats:
552 add(MenuItem(MenuItem::ExportFormats));
555 case md_importformats:
556 add(MenuItem(MenuItem::ImportFormats));
559 case md_floatlistinsert:
560 add(MenuItem(MenuItem::FloatListInsert));
564 add(MenuItem(MenuItem::FloatInsert));
568 add(MenuItem(MenuItem::PasteRecent));
572 add(MenuItem(MenuItem::Toolbars));
576 add(MenuItem(MenuItem::Branches));
581 // fallback to md_submenu
584 docstring const mlabel = translateIfPossible(lex.getDocString());
586 docstring const mname = lex.getDocString();
587 add(MenuItem(MenuItem::Submenu,
588 toqstr(mlabel), toqstr(mname), optional));
598 lex.printError("Menu::read: "
599 "Unknown menu tag: `$$Token'");
607 MenuItem const & Menu::operator[](size_type i) const
613 bool Menu::hasFunc(FuncRequest const & func) const
615 for (const_iterator it = begin(), et = end(); it != et; ++it)
616 if (it->func() == func)
622 void Menu::checkShortcuts() const
624 // This is a quadratic algorithm, but we do not care because
625 // menus are short enough
626 for (const_iterator it1 = begin(); it1 != end(); ++it1) {
627 QString shortcut = it1->shortcut();
628 if (shortcut.isEmpty())
630 if (!it1->label().contains(shortcut))
631 lyxerr << "Menu warning: menu entry \""
632 << fromqstr(it1->label())
633 << "\" does not contain shortcut `"
634 << fromqstr(shortcut) << "'." << endl;
635 for (const_iterator it2 = begin(); it2 != it1 ; ++it2) {
636 if (!it2->shortcut().compare(shortcut, Qt::CaseInsensitive)) {
637 lyxerr << "Menu warning: menu entries "
638 << '"' << fromqstr(it1->fulllabel())
639 << "\" and \"" << fromqstr(it2->fulllabel())
640 << "\" share the same shortcut."
648 bool Menu::searchMenu(FuncRequest const & func, vector<docstring> & names) const
650 const_iterator m = begin();
651 const_iterator m_end = end();
652 for (; m != m_end; ++m) {
653 if (m->kind() == MenuItem::Command && m->func() == func) {
654 names.push_back(qstring_to_ucs4(m->label()));
657 if (m->kind() == MenuItem::Submenu) {
658 names.push_back(qstring_to_ucs4(m->label()));
659 Menu const & submenu = *m->submenu();
660 if (submenu.searchMenu(func, names))
669 bool compareFormat(Format const * p1, Format const * p2)
675 QString limitStringLength(docstring const & str)
677 size_t const max_item_length = 45;
679 if (str.size() > max_item_length)
680 return toqstr(str.substr(0, max_item_length - 3) + "...");
686 void Menu::expandLastfiles()
688 LastFilesSection::LastFiles const & lf = LyX::cref().session().lastFiles().lastFiles();
689 LastFilesSection::LastFiles::const_iterator lfit = lf.begin();
693 for (; lfit != lf.end() && ii < 10; ++lfit, ++ii) {
694 string const file = lfit->absFilename();
695 QString const label = QString("%1. %2|%3").arg(ii)
696 .arg(toqstr(makeDisplayPath(file, 30))).arg(ii);
697 add(MenuItem(MenuItem::Command, label, FuncRequest(LFUN_FILE_OPEN, file)));
702 void Menu::expandDocuments()
704 Buffer * first = theBufferList().first();
709 // We cannot use a for loop as the buffer list cycles.
711 QString label = toqstr(b->fileName().displayName(20));
715 label = QString::number(ii) + ". " + label + '|' + QString::number(ii);
716 add(MenuItem(MenuItem::Command, label,
717 FuncRequest(LFUN_BUFFER_SWITCH, b->absFileName())));
719 b = theBufferList().next(b);
721 } while (b != first);
723 add(MenuItem(MenuItem::Command, qt_("No Documents Open!"),
724 FuncRequest(LFUN_NOACTION)));
729 void Menu::expandBookmarks()
731 lyx::BookmarksSection const & bm = LyX::cref().session().bookmarks();
733 for (size_t i = 1; i <= bm.size(); ++i) {
735 string const file = bm.bookmark(i).filename.absFilename();
736 QString const label = QString("%1. %2|%3").arg(i)
737 .arg(toqstr(makeDisplayPath(file, 20))).arg(i);
738 add(MenuItem(MenuItem::Command, label,
739 FuncRequest(LFUN_BOOKMARK_GOTO, convert<docstring>(i))));
745 void Menu::expandFormats(MenuItem::Kind kind, Buffer const * buf)
747 if (!buf && kind != MenuItem::ImportFormats) {
748 add(MenuItem(MenuItem::Command,
749 qt_("No Document Open!"),
750 FuncRequest(LFUN_NOACTION)));
754 typedef vector<Format const *> Formats;
759 case MenuItem::ImportFormats:
760 formats = theConverters().importableFormats();
761 action = LFUN_BUFFER_IMPORT;
763 case MenuItem::ViewFormats:
764 formats = buf->exportableFormats(true);
765 action = LFUN_BUFFER_VIEW;
767 case MenuItem::UpdateFormats:
768 formats = buf->exportableFormats(true);
769 action = LFUN_BUFFER_UPDATE;
772 formats = buf->exportableFormats(false);
773 action = LFUN_BUFFER_EXPORT;
775 sort(formats.begin(), formats.end(), &compareFormat);
777 Formats::const_iterator fit = formats.begin();
778 Formats::const_iterator end = formats.end();
779 for (; fit != end ; ++fit) {
782 QString label = toqstr((*fit)->prettyname());
783 QString const shortcut = toqstr((*fit)->shortcut());
786 case MenuItem::ImportFormats:
787 // FIXME: This is a hack, we should rather solve
788 // FIXME: bug 2488 instead.
789 if ((*fit)->name() == "text")
790 label = qt_("Plain Text");
791 else if ((*fit)->name() == "textparagraph")
792 label = qt_("Plain Text, Join Lines");
795 case MenuItem::ViewFormats:
796 case MenuItem::ExportFormats:
797 case MenuItem::UpdateFormats:
798 if (!(*fit)->documentFormat())
805 // FIXME: if we had proper support for translating the
806 // format names defined in configure.py, there would
807 // not be a need to check whether the shortcut is
808 // correct. If we add it uncondiitonally, it would
809 // create useless warnings on bad shortcuts
810 if (!shortcut.isEmpty() && label.contains(shortcut))
811 label += '|' + shortcut;
814 addWithStatusCheck(MenuItem(MenuItem::Command, label,
815 FuncRequest(action, (*fit)->name())));
817 add(MenuItem(MenuItem::Command, label,
818 FuncRequest(action, (*fit)->name())));
823 void Menu::expandFloatListInsert(Buffer const * buf)
826 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
827 FuncRequest(LFUN_NOACTION)));
831 FloatList const & floats = buf->params().documentClass().floats();
832 FloatList::const_iterator cit = floats.begin();
833 FloatList::const_iterator end = floats.end();
834 for (; cit != end; ++cit) {
835 addWithStatusCheck(MenuItem(MenuItem::Command,
836 qt_(cit->second.listName()),
837 FuncRequest(LFUN_FLOAT_LIST,
838 cit->second.type())));
843 void Menu::expandFloatInsert(Buffer const * buf)
846 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
847 FuncRequest(LFUN_NOACTION)));
851 FloatList const & floats = buf->params().documentClass().floats();
852 FloatList::const_iterator cit = floats.begin();
853 FloatList::const_iterator end = floats.end();
854 for (; cit != end; ++cit) {
856 QString const label = qt_(cit->second.name());
857 addWithStatusCheck(MenuItem(MenuItem::Command, label,
858 FuncRequest(LFUN_FLOAT_INSERT,
859 cit->second.type())));
864 void Menu::expandFlexInsert(Buffer const * buf, string s)
867 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
868 FuncRequest(LFUN_NOACTION)));
871 TextClass::InsetLayouts const & insetLayouts =
872 buf->params().documentClass().insetLayouts();
873 TextClass::InsetLayouts::const_iterator cit = insetLayouts.begin();
874 TextClass::InsetLayouts::const_iterator end = insetLayouts.end();
875 for (; cit != end; ++cit) {
876 docstring const label = cit->first;
877 if (cit->second.lyxtype() == s)
878 addWithStatusCheck(MenuItem(MenuItem::Command,
879 toqstr(label), FuncRequest(LFUN_FLEX_INSERT,
885 size_t const max_number_of_items = 25;
887 void Menu::expandToc2(Toc const & toc_list,
888 size_t from, size_t to, int depth)
890 int shortcut_count = 0;
892 // check whether depth is smaller than the smallest depth in toc.
893 int min_depth = 1000;
894 for (size_t i = from; i < to; ++i)
895 min_depth = min(min_depth, toc_list[i].depth());
896 if (min_depth > depth)
899 if (to - from <= max_number_of_items) {
900 for (size_t i = from; i < to; ++i) {
901 QString label(4 * max(0, toc_list[i].depth() - depth), ' ');
902 label += limitStringLength(toc_list[i].str());
903 if (toc_list[i].depth() == depth
904 && shortcut_count < 9) {
905 if (label.contains(QString::number(shortcut_count + 1)))
906 label += '|' + QString::number(++shortcut_count);
908 add(MenuItem(MenuItem::Command, label,
909 FuncRequest(toc_list[i].action())));
914 size_t new_pos = pos + 1;
915 while (new_pos < to &&
916 toc_list[new_pos].depth() > depth)
919 QString label(4 * max(0, toc_list[pos].depth() - depth), ' ');
920 label += limitStringLength(toc_list[pos].str());
921 if (toc_list[pos].depth() == depth &&
922 shortcut_count < 9) {
923 if (label.contains(QString::number(shortcut_count + 1)))
924 label += '|' + QString::number(++shortcut_count);
926 if (new_pos == pos + 1) {
927 add(MenuItem(MenuItem::Command,
928 label, FuncRequest(toc_list[pos].action())));
930 MenuItem item(MenuItem::Submenu, label);
931 item.setSubmenu(new Menu);
932 item.submenu()->expandToc2(toc_list, pos, new_pos, depth + 1);
941 void Menu::expandToc(Buffer const * buf)
943 // To make things very cleanly, we would have to pass buf to
944 // all MenuItem constructors and to expandToc2. However, we
945 // know that all the entries in a TOC will be have status_ ==
946 // OK, so we avoid this unnecessary overhead (JMarc)
949 add(MenuItem(MenuItem::Command, qt_("No Document Open!"),
950 FuncRequest(LFUN_NOACTION)));
954 Buffer* cbuf = const_cast<Buffer*>(buf);
955 cbuf->tocBackend().update();
956 cbuf->structureChanged();
958 // Add an entry for the master doc if this is a child doc
959 Buffer const * const master = buf->masterBuffer();
961 ParIterator const pit = par_iterator_begin(master->inset());
962 string const arg = convert<string>(pit->id());
963 FuncRequest f(LFUN_PARAGRAPH_GOTO, arg);
964 add(MenuItem(MenuItem::Command, qt_("Master Document"), f));
967 FloatList const & floatlist = buf->params().documentClass().floats();
968 TocList const & toc_list = buf->tocBackend().tocs();
969 TocList::const_iterator cit = toc_list.begin();
970 TocList::const_iterator end = toc_list.end();
971 for (; cit != end; ++cit) {
973 if (cit->first == "tableofcontents")
976 // All the rest is for floats
977 Menu * submenu = new Menu;
978 TocIterator ccit = cit->second.begin();
979 TocIterator eend = cit->second.end();
980 for (; ccit != eend; ++ccit) {
981 QString const label = limitStringLength(ccit->str());
982 submenu->add(MenuItem(MenuItem::Command, label,
983 FuncRequest(ccit->action())));
985 string const & floatName = floatlist.getType(cit->first).listName();
987 if (!floatName.empty())
988 label = qt_(floatName);
989 // BUG3633: listings is not a proper float so its name
990 // is not shown in floatlist.
991 else if (cit->first == "equation")
992 label = qt_("List of Equations");
993 else if (cit->first == "index")
994 label = qt_("List of Indexes");
995 else if (cit->first == "listing")
996 label = qt_("List of Listings");
997 else if (cit->first == "marginalnote")
998 label = qt_("List of Marginal notes");
999 else if (cit->first == "note")
1000 label = qt_("List of Notes");
1001 else if (cit->first == "footnote")
1002 label = qt_("List of Foot notes");
1003 else if (cit->first == "label")
1004 label = qt_("Labels and References");
1005 else if (cit->first == "citation")
1006 label = qt_("List of Citations");
1007 // this should not happen now, but if something else like
1008 // listings is added later, this can avoid an empty menu name.
1010 label = qt_("Other floats");
1011 MenuItem item(MenuItem::Submenu, label);
1012 item.setSubmenu(submenu);
1016 // Handle normal TOC
1017 cit = toc_list.find("tableofcontents");
1019 addWithStatusCheck(MenuItem(MenuItem::Command,
1020 qt_("No Table of contents"),
1023 expandToc2(cit->second, 0, cit->second.size(), 0);
1028 void Menu::expandPasteRecent()
1030 vector<docstring> const sel = cap::availableSelections();
1032 vector<docstring>::const_iterator cit = sel.begin();
1033 vector<docstring>::const_iterator end = sel.end();
1035 for (unsigned int index = 0; cit != end; ++cit, ++index) {
1036 add(MenuItem(MenuItem::Command, toqstr(*cit),
1037 FuncRequest(LFUN_PASTE, convert<string>(index))));
1042 void Menu::expandToolbars()
1045 // extracts the toolbars from the backend
1046 ToolbarBackend::Toolbars::const_iterator cit = toolbarbackend.begin();
1047 ToolbarBackend::Toolbars::const_iterator end = toolbarbackend.end();
1049 for (; cit != end; ++cit) {
1050 QString label = qt_(cit->gui_name);
1051 // frontends are not supposed to turn on/off toolbars,
1052 // if they cannot update ToolbarBackend::flags. That
1053 // is to say, ToolbarsBackend::flags should reflect
1054 // the true state of toolbars.
1056 // menu is displayed as
1060 // in the case of auto.
1061 if (cit->flags & ToolbarInfo::AUTO)
1062 label += qt_(" (auto)");
1063 add(MenuItem(MenuItem::Command, label,
1064 FuncRequest(LFUN_TOOLBAR_TOGGLE, cit->name + " allowauto")));
1069 void Menu::expandBranches(Buffer const * buf)
1072 add(MenuItem(MenuItem::Command,
1073 qt_("No Document Open!"),
1074 FuncRequest(LFUN_NOACTION)));
1078 BufferParams const & params = buf->masterBuffer()->params();
1079 if (params.branchlist().empty()) {
1080 add(MenuItem(MenuItem::Command,
1081 qt_("No Branch in Document!"),
1082 FuncRequest(LFUN_NOACTION)));
1086 BranchList::const_iterator cit = params.branchlist().begin();
1087 BranchList::const_iterator end = params.branchlist().end();
1089 for (int ii = 1; cit != end; ++cit, ++ii) {
1090 docstring label = cit->getBranch();
1092 label = convert<docstring>(ii) + ". " + label + char_type('|') + convert<docstring>(ii);
1093 addWithStatusCheck(MenuItem(MenuItem::Command, toqstr(label),
1094 FuncRequest(LFUN_BRANCH_INSERT,
1095 cit->getBranch())));
1102 struct Menus::Impl {
1104 bool hasMenu(QString const &) const;
1106 Menu & getMenu(QString const &);
1108 Menu const & getMenu(QString const &) const;
1110 /// Expands some special entries of the menu
1111 /** The entries with the following kind are expanded to a
1112 sequence of Command MenuItems: Lastfiles, Documents,
1113 ViewFormats, ExportFormats, UpdateFormats, Branches
1115 void expand(Menu const & frommenu, Menu & tomenu,
1116 Buffer const *) const;
1118 /// Initialize specific MACOS X menubar
1119 void macxMenuBarInit(GuiView * view);
1121 /// Mac special menu.
1122 /** This defines a menu whose entries list the FuncRequests
1123 that will be removed by expand() in other menus. This is
1124 used by the Qt/Mac code
1133 typedef QHash<QString, GuiPopupMenu *> NameMap;
1135 /// name to menu for \c menu() method.
1140 /////////////////////////////////////////////////////////////////////
1141 // Menus::Impl implementation
1142 /////////////////////////////////////////////////////////////////////
1145 Here is what the Qt documentation says about how a menubar is chosen:
1147 1) If the window has a QMenuBar then it is used. 2) If the window
1148 is a modal then its menubar is used. If no menubar is specified
1149 then a default menubar is used (as documented below) 3) If the
1150 window has no parent then the default menubar is used (as
1153 The above 3 steps are applied all the way up the parent window
1154 chain until one of the above are satisifed. If all else fails a
1155 default menubar will be created, the default menubar on Qt/Mac is
1156 an empty menubar, however you can create a different default
1157 menubar by creating a parentless QMenuBar, the first one created
1158 will thus be designated the default menubar, and will be used
1159 whenever a default menubar is needed.
1161 Thus, for Qt/Mac, we add the menus to a free standing menubar, so
1162 that this menubar will be used also when one of LyX' dialogs has
1165 void Menus::Impl::macxMenuBarInit(GuiView * view)
1167 // The Mac menubar initialisation must be done only once!
1168 static bool done = false;
1173 /* Since Qt 4.2, the qt/mac menu code has special code for
1174 specifying the role of a menu entry. However, it does not
1175 work very well with our scheme of creating menus on demand,
1176 and therefore we need to put these entries in a special
1177 invisible menu. (JMarc)
1180 /* The entries of our special mac menu. If we add support for
1181 * special entries in Menus, we could imagine something
1183 * SpecialItem About " "About LyX" "dialog-show aboutlyx"
1184 * and therefore avoid hardcoding. I am not sure it is worth
1185 * the hassle, though. (JMarc)
1187 struct MacMenuEntry {
1191 QAction::MenuRole role;
1194 MacMenuEntry entries[] = {
1195 {LFUN_DIALOG_SHOW, "aboutlyx", "About LyX",
1196 QAction::AboutRole},
1197 {LFUN_DIALOG_SHOW, "prefs", "Preferences",
1198 QAction::PreferencesRole},
1199 {LFUN_RECONFIGURE, "", "Reconfigure",
1200 QAction::ApplicationSpecificRole},
1201 {LFUN_LYX_QUIT, "", "Quit LyX", QAction::QuitRole}
1203 const size_t num_entries = sizeof(entries) / sizeof(entries[0]);
1205 // the special menu for Menus.
1206 for (size_t i = 0 ; i < num_entries ; ++i) {
1207 FuncRequest const func(entries[i].action,
1208 from_utf8(entries[i].arg));
1209 specialmenu_.add(MenuItem(MenuItem::Command, entries[i].label, func));
1212 // add the entries to a QMenu that will eventually be empty
1213 // and therefore invisible.
1214 QMenu * qMenu = view->menuBar()->addMenu("special");
1215 Menu::const_iterator cit = specialmenu_.begin();
1216 Menu::const_iterator end = specialmenu_.end();
1217 for (size_t i = 0 ; cit != end ; ++cit, ++i) {
1218 Action * action = new Action(*view, QIcon(), cit->label(),
1219 cit->func(), QString());
1220 action->setMenuRole(entries[i].role);
1221 qMenu->addAction(action);
1226 void Menus::Impl::expand(Menu const & frommenu, Menu & tomenu,
1227 Buffer const * buf) const
1229 if (!tomenu.empty())
1232 for (Menu::const_iterator cit = frommenu.begin();
1233 cit != frommenu.end() ; ++cit) {
1234 switch (cit->kind()) {
1235 case MenuItem::Lastfiles:
1236 tomenu.expandLastfiles();
1239 case MenuItem::Documents:
1240 tomenu.expandDocuments();
1243 case MenuItem::Bookmarks:
1244 tomenu.expandBookmarks();
1247 case MenuItem::ImportFormats:
1248 case MenuItem::ViewFormats:
1249 case MenuItem::UpdateFormats:
1250 case MenuItem::ExportFormats:
1251 tomenu.expandFormats(cit->kind(), buf);
1254 case MenuItem::CharStyles:
1255 tomenu.expandFlexInsert(buf, "charstyle");
1258 case MenuItem::Custom:
1259 tomenu.expandFlexInsert(buf, "custom");
1262 case MenuItem::Elements:
1263 tomenu.expandFlexInsert(buf, "element");
1266 case MenuItem::FloatListInsert:
1267 tomenu.expandFloatListInsert(buf);
1270 case MenuItem::FloatInsert:
1271 tomenu.expandFloatInsert(buf);
1274 case MenuItem::PasteRecent:
1275 tomenu.expandPasteRecent();
1278 case MenuItem::Toolbars:
1279 tomenu.expandToolbars();
1282 case MenuItem::Branches:
1283 tomenu.expandBranches(buf);
1287 tomenu.expandToc(buf);
1290 case MenuItem::Submenu: {
1291 MenuItem item(*cit);
1292 item.setSubmenu(new Menu(cit->submenuname()));
1293 expand(getMenu(cit->submenuname()), *item.submenu(), buf);
1294 tomenu.addWithStatusCheck(item);
1298 case MenuItem::Separator:
1299 tomenu.addWithStatusCheck(*cit);
1302 case MenuItem::Command:
1303 if (!specialmenu_.hasFunc(cit->func()))
1304 tomenu.addWithStatusCheck(*cit);
1308 // we do not want the menu to end with a separator
1309 if (!tomenu.empty() && tomenu.items_.back().kind() == MenuItem::Separator)
1310 tomenu.items_.pop_back();
1312 // Check whether the shortcuts are unique
1313 tomenu.checkShortcuts();
1317 bool Menus::Impl::hasMenu(QString const & name) const
1319 return find_if(menulist_.begin(), menulist_.end(),
1320 MenuNamesEqual(name)) != menulist_.end();
1324 Menu const & Menus::Impl::getMenu(QString const & name) const
1326 const_iterator cit = find_if(menulist_.begin(), menulist_.end(),
1327 MenuNamesEqual(name));
1328 if (cit == menulist_.end())
1329 lyxerr << "No submenu named " << fromqstr(name) << endl;
1330 BOOST_ASSERT(cit != menulist_.end());
1335 Menu & Menus::Impl::getMenu(QString const & name)
1337 iterator it = find_if(menulist_.begin(), menulist_.end(),
1338 MenuNamesEqual(name));
1339 if (it == menulist_.end())
1340 lyxerr << "No submenu named " << fromqstr(name) << endl;
1341 BOOST_ASSERT(it != menulist_.end());
1345 /////////////////////////////////////////////////////////////////////
1346 // Menus implementation
1347 /////////////////////////////////////////////////////////////////////
1349 Menus::Menus(): d(new Impl) {}
1352 void Menus::read(Lexer & lex)
1361 struct keyword_item menutags[md_last - 1] = {
1362 { "end", md_endmenuset },
1363 { "menu", md_menu },
1364 { "menubar", md_menubar }
1368 if (compare_ascii_no_case(lex.getString(), "menuset")) {
1369 lyxerr << "Menubackend::read: ERROR wrong token:`"
1370 << lex.getString() << '\'' << endl;
1373 lex.pushTable(menutags, md_last - 1);
1374 if (lyxerr.debugging(Debug::PARSER))
1375 lex.printTable(lyxerr);
1379 while (lex.isOK() && !quit) {
1380 switch (lex.lex()) {
1382 d->menubar_.read(lex);
1386 QString const name = toqstr(lex.getDocString());
1387 if (d->hasMenu(name))
1388 d->getMenu(name).read(lex);
1392 d->menulist_.push_back(menu);
1400 lex.printError("menubackend::read: "
1401 "Unknown menu tag: `$$Token'");
1409 bool Menus::searchMenu(FuncRequest const & func,
1410 vector<docstring> & names) const
1412 return d->menubar_.searchMenu(func, names);
1416 void Menus::fillMenuBar(GuiView * view)
1418 // Clear all menubar contents before filling it.
1419 view->menuBar()->clear();
1422 // setup special mac specific menu item
1423 macxMenuBarInit(view);
1426 LYXERR(Debug::GUI, "populating menu bar" << fromqstr(d->menubar_.name()));
1428 if (d->menubar_.size() == 0) {
1429 LYXERR(Debug::GUI, "\tERROR: empty menu bar"
1430 << fromqstr(d->menubar_.name()));
1434 LYXERR(Debug::GUI, "menu bar entries "
1435 << d->menubar_.size());
1439 d->expand(d->menubar_, menu, view->buffer());
1441 Menu::const_iterator m = menu.begin();
1442 Menu::const_iterator end = menu.end();
1444 for (; m != end; ++m) {
1446 if (m->kind() != MenuItem::Submenu) {
1447 LYXERR(Debug::GUI, "\tERROR: not a submenu " << fromqstr(m->label()));
1451 LYXERR(Debug::GUI, "menu bar item " << fromqstr(m->label())
1452 << " is a submenu named " << fromqstr(m->submenuname()));
1454 QString name = m->submenuname();
1455 if (!d->hasMenu(name)) {
1456 LYXERR(Debug::GUI, "\tERROR: " << fromqstr(name)
1457 << " submenu has no menu!");
1461 GuiPopupMenu * qmenu = new GuiPopupMenu(view, *m, true);
1462 view->menuBar()->addMenu(qmenu);
1464 d->name_map_[name] = qmenu;
1469 void Menus::updateMenu(QString const & name)
1471 GuiPopupMenu * qmenu = d->name_map_[name];
1472 LYXERR(Debug::GUI, "GuiPopupMenu::updateView()"
1473 << "\tTriggered menu: " << fromqstr(qmenu->name));
1476 if (qmenu->name.isEmpty())
1479 // Here, We make sure that theLyXFunc points to the correct LyXView.
1480 theLyXFunc().setLyXView(qmenu->view);
1482 Menu const & fromLyxMenu = d->getMenu(qmenu->name);
1483 d->expand(fromLyxMenu, *qmenu->top_level_menu, qmenu->view->buffer());
1485 if (!d->hasMenu(qmenu->top_level_menu->name())) {
1486 LYXERR(Debug::GUI, "\tWARNING: menu seems empty"
1487 << fromqstr(qmenu->top_level_menu->name()));
1489 qmenu->populate(qmenu, qmenu->top_level_menu);
1493 QMenu * Menus::menu(QString const & name)
1495 LYXERR(Debug::GUI, "Context menu requested: " << fromqstr(name));
1496 GuiPopupMenu * menu = d->name_map_.value(name, 0);
1498 LYXERR0("resquested context menu not found: " << fromqstr(name));
1502 } // namespace frontend
1505 #include "Menus_moc.cpp"