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. */
49 /** This is a list of viewable formats
50 typically for the File->View menu. */
52 /** This is a list of updatable formats
53 typically for the File->Update menu. */
55 /** This is a list of exportable formats
56 typically for the File->Export menu. */
58 /** This is a list of importable formats
59 typically for the File->Export menu. */
62 /// Create a Command type MenuItem
64 string const & label = string(),
65 string const & command = string(),
66 bool optional = false);
70 bool optional = false)
71 : kind_(kind), label_(label),
72 action_(action), submenu_(), optional_(optional) {}
74 /// The label of a given menuitem
75 string const label() const { return token(label_, '|', 0); }
76 /// The keyboard shortcut (usually underlined in the entry)
77 string const shortcut() const { return token(label_, '|', 1); }
78 /// The complete label, with label and shortcut separated by a '|'
79 string const fulllabel() const { return label_;}
81 Kind kind() const { return kind_; }
82 /// the action (if relevant)
83 int action() const { return action_; }
84 /// the description of the submenu (if relevant)
85 string const & submenu() const { return submenu_; }
86 /// returns true if the entry should be ommited when disabled
87 bool optional() const { return optional_; }
106 typedef std::vector<MenuItem> ItemList;
108 typedef ItemList::const_iterator const_iterator;
110 explicit Menu(string const & name = string(), bool mb = false)
111 : menubar_(mb), name_(name) {}
113 Menu & add(MenuItem const &);
115 Menu & read(LyXLex &);
116 /// Expands some special entries of the menu
117 /** The entries with the following kind are expanded to a
118 sequence of Command MenuItems: Lastfiles, Documents,
119 ViewFormats, ExportFormats, UpdateFormats
121 void expand(Menu & tomenu, Buffer *) const;
123 bool menubar() const { return menubar_; }
125 string const & name() const { return name_; }
127 bool empty() const { return items_.empty(); }
129 ItemList::size_type size() const { return items_.size(); }
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 */