4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * Full author contact details are available in file CREDITS.
16 #include "FuncStatus.h"
17 #include "FuncRequest.h"
19 #include <boost/shared_ptr.hpp>
33 /// The type of elements that can be in a menu
41 /** This is the list of last opened file,
42 typically for the File menu. */
44 /** This is the list of opened Documents,
45 typically for the Documents menu. */
47 /** This is the bookmarks */
51 /** This is a list of viewable formats
52 typically for the File->View menu. */
54 /** This is a list of updatable formats
55 typically for the File->Update menu. */
57 /** This is a list of exportable formats
58 typically for the File->Export menu. */
60 /** This is a list of importable formats
61 typically for the File->Export menu. */
63 /** This is the list of elements available
64 * for insertion into document. */
66 /** This is the list of user-configurable
67 insets to insert into document */
69 /** This is the list of floats that we can
72 /** This is the list of floats that we can
75 /** This is the list of selections that can
80 /** Available branches in document */
84 explicit MenuItem(Kind kind);
87 docstring const & label,
88 docstring const & submenu = docstring(),
89 bool optional = false);
92 docstring const & label,
93 FuncRequest const & func,
94 bool optional = false);
96 /// This one is just to please boost::shared_ptr<>
98 /// The label of a given menuitem
99 docstring const label() const;
100 /// The keyboard shortcut (usually underlined in the entry)
101 docstring const shortcut() const;
102 /// The complete label, with label and shortcut separated by a '|'
103 docstring const fulllabel() const { return label_;}
104 /// The kind of entry
105 Kind kind() const { return kind_; }
106 /// the action (if relevant)
107 FuncRequest const & func() const { return func_; }
108 /// returns true if the entry should be ommited when disabled
109 bool optional() const { return optional_; }
110 /// returns the status of the lfun associated with this entry
111 FuncStatus const & status() const { return status_; }
112 /// returns the status of the lfun associated with this entry
113 FuncStatus & status() { return status_; }
114 /// returns the status of the lfun associated with this entry
115 void status(FuncStatus const & status) { status_ = status; }
117 * returns the binding associated to this action.
118 * Use the native UI format when \c forgui is true.
120 docstring const binding(bool forgui) const;
121 /// the description of the submenu (if relevant)
122 docstring const & submenuname() const { return submenuname_; }
123 /// set the description of the submenu
124 void submenuname(docstring const & name) { submenuname_ = name; }
126 Menu * submenu() const { return submenu_.get(); }
128 void submenu(Menu * menu);
131 //friend class MenuBackend;
139 docstring submenuname_;
145 boost::shared_ptr<Menu> submenu_;
153 typedef std::vector<MenuItem> ItemList;
155 typedef ItemList::const_iterator const_iterator;
157 typedef ItemList::size_type size_type;
159 explicit Menu(docstring const & name = docstring())
161 /// Add the menu item unconditionally
162 Menu & add(MenuItem const &);
163 /// Checks the associated FuncRequest status before adding the
165 Menu & addWithStatusCheck(MenuItem const &);
167 Menu & read(Lexer &);
169 docstring const & name() const { return name_; }
171 bool empty() const { return items_.empty(); }
172 /// Clear the menu content.
173 void clear() { items_.clear(); }
175 ItemList::size_type size() const { return items_.size(); }
177 MenuItem const & operator[](size_type) const;
179 bool hasFunc(FuncRequest const &) const;
181 const_iterator begin() const {
182 return items_.begin();
185 const_iterator end() const {
189 // Check whether the menu shortcuts are unique
190 void checkShortcuts() const;
193 friend class MenuBackend;
205 typedef std::vector<Menu> MenuList;
207 typedef MenuList::const_iterator const_iterator;
209 typedef MenuList::iterator iterator;
215 void add(Menu const &);
217 bool hasMenu(docstring const &) const;
219 Menu & getMenu(docstring const &);
221 Menu const & getMenu(docstring const &) const;
223 Menu const & getMenubar() const;
225 bool empty() const { return menulist_.empty(); }
226 /** This defines a menu whose entries list the FuncRequests
227 that will be removed by expand() in other menus. This is
228 used by the Qt/Mac code
230 void specialMenu(Menu const &);
232 Menu const & specialMenu() { return specialmenu_; }
234 /// Expands some special entries of the menu
235 /** The entries with the following kind are expanded to a
236 sequence of Command MenuItems: Lastfiles, Documents,
237 ViewFormats, ExportFormats, UpdateFormats, Branches
239 void expand(Menu const & frommenu, Menu & tomenu,
240 Buffer const *) const;
242 const_iterator begin() const {
243 return menulist_.begin();
247 return menulist_.begin();
250 const_iterator end() const {
251 return menulist_.end();
255 return menulist_.end();
267 extern MenuBackend menubackend;
272 #endif /* MENUBACKEND_H */