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; }
113 /// returns the binding associated to this action
114 docstring const binding() const;
115 /// the description of the submenu (if relevant)
116 docstring const & submenuname() const { return submenuname_; }
117 /// set the description of the submenu
118 void submenuname(docstring const & name) { submenuname_ = name; }
120 Menu * submenu() const { return submenu_.get(); }
122 void submenu(Menu * menu);
125 //friend class MenuBackend;
133 docstring submenuname_;
139 boost::shared_ptr<Menu> submenu_;
147 typedef std::vector<MenuItem> ItemList;
149 typedef ItemList::const_iterator const_iterator;
151 typedef ItemList::size_type size_type;
153 explicit Menu(docstring const & name = docstring())
155 /// Add the menu item unconditionally
156 Menu & add(MenuItem const &);
157 /// Checks the associated FuncRequest status before adding the
159 Menu & addWithStatusCheck(MenuItem const &);
161 Menu & read(LyXLex &);
163 docstring const & name() const { return name_; }
165 bool empty() const { return items_.empty(); }
166 /// Clear the menu content.
167 void clear() { items_.clear(); }
169 ItemList::size_type size() const { return items_.size(); }
171 MenuItem const & operator[](size_type) const;
173 bool hasFunc(FuncRequest const &) const;
175 const_iterator begin() const {
176 return items_.begin();
179 const_iterator end() const {
183 // Check whether the menu shortcuts are unique
184 void checkShortcuts() const;
187 friend class MenuBackend;
199 typedef std::vector<Menu> MenuList;
201 typedef MenuList::const_iterator const_iterator;
203 typedef MenuList::iterator iterator;
205 MenuBackend() : specialmenu_(0) {}
209 void add(Menu const &);
211 bool hasMenu(docstring const &) const;
213 Menu & getMenu(docstring const &);
215 Menu const & getMenu(docstring const &) const;
217 Menu const & getMenubar() const;
219 bool empty() const { return menulist_.empty(); }
220 /** This defines a menu whose entries list the FuncRequests
221 will be removed by expand() in other menus. This is used by
224 void specialMenu(docstring const &);
225 /// Expands some special entries of the menu
226 /** The entries with the following kind are expanded to a
227 sequence of Command MenuItems: Lastfiles, Documents,
228 ViewFormats, ExportFormats, UpdateFormats, Branches
230 void expand(Menu const & frommenu, Menu & tomenu,
231 Buffer const *) const;
233 const_iterator begin() const {
234 return menulist_.begin();
238 return menulist_.begin();
241 const_iterator end() const {
242 return menulist_.end();
246 return menulist_.end();
258 extern MenuBackend menubackend;
263 #endif /* MENUBACKEND_H */