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
75 /** Available branches in document */
79 explicit MenuItem(Kind kind);
82 docstring const & label,
83 docstring const & submenu = docstring(),
84 bool optional = false);
87 docstring const & label,
88 FuncRequest const & func,
89 bool optional = false);
91 /// This one is just to please boost::shared_ptr<>
93 /// The label of a given menuitem
94 docstring const label() const;
95 /// The keyboard shortcut (usually underlined in the entry)
96 docstring const shortcut() const;
97 /// The complete label, with label and shortcut separated by a '|'
98 docstring const fulllabel() const { return label_;}
100 Kind kind() const { return kind_; }
101 /// the action (if relevant)
102 FuncRequest const & func() const { return func_; }
103 /// returns true if the entry should be ommited when disabled
104 bool optional() const { return optional_; }
105 /// returns the status of the lfun associated with this entry
106 FuncStatus const & status() const { return status_; }
107 /// returns the status of the lfun associated with this entry
108 FuncStatus & status() { return status_; }
109 /// returns the status of the lfun associated with this entry
110 void status(FuncStatus const & status) { status_ = status; }
111 /// returns the binding associated to this action
112 docstring const binding() const;
113 /// the description of the submenu (if relevant)
114 docstring const & submenuname() const { return submenuname_; }
115 /// set the description of the submenu
116 void submenuname(docstring const & name) { submenuname_ = name; }
118 Menu * submenu() const { return submenu_.get(); }
120 void submenu(Menu * menu);
123 //friend class MenuBackend;
131 docstring submenuname_;
137 boost::shared_ptr<Menu> submenu_;
145 typedef std::vector<MenuItem> ItemList;
147 typedef ItemList::const_iterator const_iterator;
149 typedef ItemList::size_type size_type;
151 explicit Menu(docstring const & name = docstring())
153 /// Add the menu item unconditionally
154 Menu & add(MenuItem const &);
155 /// Checks the associated FuncRequest status before adding the
157 Menu & addWithStatusCheck(MenuItem const &);
159 Menu & read(LyXLex &);
161 docstring const & name() const { return name_; }
163 bool empty() const { return items_.empty(); }
164 /// Clear the menu content.
165 void clear() { items_.clear(); }
167 ItemList::size_type size() const { return items_.size(); }
169 MenuItem const & operator[](size_type) const;
171 bool hasFunc(FuncRequest const &) const;
173 const_iterator begin() const {
174 return items_.begin();
177 const_iterator end() const {
181 // Check whether the menu shortcuts are unique
182 void checkShortcuts() const;
185 friend class MenuBackend;
197 typedef std::vector<Menu> MenuList;
199 typedef MenuList::const_iterator const_iterator;
201 typedef MenuList::iterator iterator;
203 MenuBackend() : specialmenu_(0) {}
207 void add(Menu const &);
209 bool hasMenu(docstring const &) const;
211 Menu & getMenu(docstring const &);
213 Menu const & getMenu(docstring const &) const;
215 Menu const & getMenubar() const;
217 bool empty() const { return menulist_.empty(); }
218 /** This defines a menu whose entries list the FuncRequests
219 will be removed by expand() in other menus. This is used by
222 void specialMenu(docstring const &);
223 /// Expands some special entries of the menu
224 /** The entries with the following kind are expanded to a
225 sequence of Command MenuItems: Lastfiles, Documents,
226 ViewFormats, ExportFormats, UpdateFormats, Branches
228 void expand(Menu const & frommenu, Menu & tomenu,
229 Buffer const *) const;
231 const_iterator begin() const {
232 return menulist_.begin();
236 return menulist_.begin();
239 const_iterator end() const {
240 return menulist_.end();
244 return menulist_.end();
256 extern MenuBackend menubackend;
261 #endif /* MENUBACKEND_H */