1 /* This file is part of -*- C++ -*-
2 * ======================================================
4 * LyX, The Document Processor
6 * Copyright 1995 Matthias Ettrich
7 * Copyright 1995-2000 The LyX Team.
9 * This file is Copyright 1999
10 * Jean-Marc Lasgouttes
12 *======================================================*/
22 #include "support/lstrings.h"
31 /// The type of elements that can be in a menu
39 /** This is the list of last opened file,
40 typically for the File menu. */
42 /** This is the list of opened Documents,
43 typically for the Documents menu. */
47 /** This is a list of viewable formats
48 typically for the File->View menu. */
50 /** This is a list of updatable formats
51 typically for the File->Update menu. */
53 /** This is a list of exportable formats
54 typically for the File->Export menu. */
56 /** This is a list of importable formats
57 typically for the File->Export menu. */
60 /// Create a Command type MenuItem
62 string const & label = string(),
63 string const & command = string(),
64 bool optional = false);
68 bool optional = false)
69 : kind_(kind), label_(label),
70 action_(action), submenu_(), optional_(optional) {}
72 /// The label of a given menuitem
73 string const label() const { return token(label_, '|', 0); }
74 /// The keyboard shortcut (usually underlined in the entry)
75 string const shortcut() const { return token(label_, '|', 1); }
76 /// The complete label, with label and shortcut separated by a '|'
77 string const fulllabel() const { return label_;}
79 Kind kind() const { return kind_; }
80 /// the action (if relevant)
81 int action() const { return action_; }
82 /// the description of the submenu (if relevant)
83 string const & submenu() const { return submenu_; }
84 /// returns true if the entry should be ommited when disabled
85 bool optional() const { return optional_; }
104 typedef std::vector<MenuItem> ItemList;
106 typedef ItemList::const_iterator const_iterator;
108 explicit Menu(string const & name = string(), bool mb = false)
109 : menubar_(mb), name_(name) {}
111 Menu & add(MenuItem const &);
113 Menu & read(LyXLex &);
114 /// Expands some special entries of the menu
115 /** The entries with the following kind are expanded to a
116 sequence of Command MenuItems: Lastfiles, Documents,
117 ViewFormats, ExportFormats, UpdateFormats
119 void expand(Menu & tomenu, Buffer *) const;
121 bool menubar() const { return menubar_; }
123 string const & name() const { return name_; }
125 bool empty() const { return items_.empty(); }
127 ItemList::size_type size() const { return items_.size(); }
129 bool hasSubmenu(string const &) const;
131 const_iterator begin() const {
132 return items_.begin();
135 const_iterator end() const {
139 // Check whether the menu shortcuts are unique
140 void checkShortcuts() const;
156 typedef std::vector<Menu> MenuList;
158 typedef MenuList::const_iterator const_iterator;
161 /// Set default values for menu structure.
164 void add(Menu const &);
166 bool hasMenu(string const &) const;
168 Menu & getMenu (string const &);
170 Menu const & getMenu (string const &) const;
172 bool empty() const { return menulist_.empty(); }
174 const_iterator begin() const {
175 return menulist_.begin();
178 const_iterator end() const {
179 return menulist_.end();
187 extern MenuBackend menubackend;
189 #endif /* MENUBACKEND_H */