1 /* This file is part of -*- C++ -*-
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2001 The LyX Team.
9 * This file is Copyright 1999
10 * Jean-Marc Lasgouttes
12 *======================================================*/
23 #include <boost/shared_ptr.hpp>
32 /// The type of elements that can be in a menu
40 /** This is the list of last opened file,
41 typically for the File menu. */
43 /** This is the list of opened Documents,
44 typically for the Documents menu. */
48 /** This is a list of viewable formats
49 typically for the File->View menu. */
51 /** This is a list of updatable formats
52 typically for the File->Update menu. */
54 /** This is a list of exportable formats
55 typically for the File->Export menu. */
57 /** This is a list of importable formats
58 typically for the File->Export menu. */
60 /** This is the list of floats that we can
63 /** This is the list of floats that we can
67 /// Create a Command type MenuItem
69 string const & label = string(),
70 string const & command = string(),
71 bool optional = false);
75 bool optional = false)
76 : kind_(kind), label_(label),
77 action_(action), submenuname_(), optional_(optional) {}
79 /// This one is just to please boost::shared_ptr<>
81 /// The label of a given menuitem
82 string const label() const;
83 /// The keyboard shortcut (usually underlined in the entry)
84 string const shortcut() const;
85 /// The complete label, with label and shortcut separated by a '|'
86 string const fulllabel() const { return label_;}
88 Kind kind() const { return kind_; }
89 /// the action (if relevant)
90 int action() const { return action_; }
91 /// the description of the submenu (if relevant)
92 string const & submenuname() const { return submenuname_; }
93 /// returns true if the entry should be ommited when disabled
94 bool optional() const { return optional_; }
96 Menu & submenu() const { return *submenu_.get(); }
98 friend class MenuBackend;
110 boost::shared_ptr<Menu> submenu_;
118 typedef std::vector<MenuItem> ItemList;
120 typedef ItemList::const_iterator const_iterator;
122 explicit Menu(string const & name = string())
125 Menu & add(MenuItem const &);
127 Menu & read(LyXLex &);
129 string const & name() const { return name_; }
131 bool empty() const { return items_.empty(); }
133 ItemList::size_type size() const { return items_.size(); }
135 bool hasSubmenu(string const &) const;
137 const_iterator begin() const {
138 return items_.begin();
141 const_iterator end() const {
145 // Check whether the menu shortcuts are unique
146 void checkShortcuts() const;
160 typedef std::vector<Menu> MenuList;
162 typedef MenuList::const_iterator const_iterator;
165 /// Set default values for menu structure.
168 void add(Menu const &);
170 bool hasMenu(string const &) const;
172 Menu & getMenu (string const &);
174 Menu const & getMenu (string const &) const;
176 Menu const & getMenubar() const;
178 bool empty() const { return menulist_.empty(); }
179 /// Expands some special entries of the menu
180 /** The entries with the following kind are expanded to a
181 sequence of Command MenuItems: Lastfiles, Documents,
182 ViewFormats, ExportFormats, UpdateFormats
184 void expand(Menu const & frommenu, Menu & tomenu,
185 Buffer const *) const;
187 const_iterator begin() const {
188 return menulist_.begin();
191 const_iterator end() const {
192 return menulist_.end();
202 extern MenuBackend menubackend;
204 #endif /* MENUBACKEND_H */