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 floats that we can
69 /** This is the list of floats that we can
72 /** This is the list of selections that can
77 /** Available branches in document */
81 explicit MenuItem(Kind kind);
84 docstring const & label,
85 docstring const & submenu = docstring(),
86 bool optional = false);
89 docstring const & label,
90 FuncRequest const & func,
91 bool optional = false);
93 /// This one is just to please boost::shared_ptr<>
95 /// The label of a given menuitem
96 docstring const label() const;
97 /// The keyboard shortcut (usually underlined in the entry)
98 docstring const shortcut() const;
99 /// The complete label, with label and shortcut separated by a '|'
100 docstring const fulllabel() const { return label_;}
101 /// The kind of entry
102 Kind kind() const { return kind_; }
103 /// the action (if relevant)
104 FuncRequest const & func() const { return func_; }
105 /// returns true if the entry should be ommited when disabled
106 bool optional() const { return optional_; }
107 /// returns the status of the lfun associated with this entry
108 FuncStatus const & status() const { return status_; }
109 /// returns the status of the lfun associated with this entry
110 FuncStatus & status() { return status_; }
111 /// returns the status of the lfun associated with this entry
112 void status(FuncStatus const & status) { status_ = status; }
114 * returns the binding associated to this action.
115 * Use the native UI format when \c forgui is true.
117 docstring const binding(bool forgui) const;
118 /// the description of the submenu (if relevant)
119 docstring const & submenuname() const { return submenuname_; }
120 /// set the description of the submenu
121 void submenuname(docstring const & name) { submenuname_ = name; }
123 Menu * submenu() const { return submenu_.get(); }
125 void submenu(Menu * menu);
128 //friend class MenuBackend;
136 docstring submenuname_;
142 boost::shared_ptr<Menu> submenu_;
150 typedef std::vector<MenuItem> ItemList;
152 typedef ItemList::const_iterator const_iterator;
154 typedef ItemList::size_type size_type;
156 explicit Menu(docstring const & name = docstring())
158 /// Add the menu item unconditionally
159 Menu & add(MenuItem const &);
160 /// Checks the associated FuncRequest status before adding the
162 Menu & addWithStatusCheck(MenuItem const &);
164 Menu & read(Lexer &);
166 docstring const & name() const { return name_; }
168 bool empty() const { return items_.empty(); }
169 /// Clear the menu content.
170 void clear() { items_.clear(); }
172 ItemList::size_type size() const { return items_.size(); }
174 MenuItem const & operator[](size_type) const;
176 bool hasFunc(FuncRequest const &) const;
178 const_iterator begin() const {
179 return items_.begin();
182 const_iterator end() const {
186 // Check whether the menu shortcuts are unique
187 void checkShortcuts() const;
190 friend class MenuBackend;
202 typedef std::vector<Menu> MenuList;
204 typedef MenuList::const_iterator const_iterator;
206 typedef MenuList::iterator iterator;
212 void add(Menu const &);
214 bool hasMenu(docstring const &) const;
216 Menu & getMenu(docstring const &);
218 Menu const & getMenu(docstring const &) const;
220 Menu const & getMenubar() const;
222 bool empty() const { return menulist_.empty(); }
223 /** This defines a menu whose entries list the FuncRequests
224 that will be removed by expand() in other menus. This is
225 used by the Qt/Mac code
227 void specialMenu(Menu const &);
229 Menu const & specialMenu() { return specialmenu_; }
231 /// Expands some special entries of the menu
232 /** The entries with the following kind are expanded to a
233 sequence of Command MenuItems: Lastfiles, Documents,
234 ViewFormats, ExportFormats, UpdateFormats, Branches
236 void expand(Menu const & frommenu, Menu & tomenu,
237 Buffer const *) const;
239 const_iterator begin() const {
240 return menulist_.begin();
244 return menulist_.begin();
247 const_iterator end() const {
248 return menulist_.end();
252 return menulist_.end();
264 extern MenuBackend menubackend;
269 #endif /* MENUBACKEND_H */