]> git.lyx.org Git - lyx.git/blob - src/MenuBackend.h
b630c54e4cc8b7d205229a3d8619a967758fafa6
[lyx.git] / src / MenuBackend.h
1 /* This file is part of              -*- C++ -*-
2 * ======================================================
3 *
4 *           LyX, The Document Processor
5 *
6 *           Copyright 1995 Matthias Ettrich
7 *           Copyright 1995-2001 The LyX Team.
8 *
9 *           This file is Copyright 1999
10 *           Jean-Marc Lasgouttes
11 *
12 *======================================================*/
13
14 #ifndef MENUBACKEND_H
15 #define MENUBACKEND_H
16
17 #ifdef __GNUG__
18 #pragma interface
19 #endif
20
21 #include "LString.h"
22 #include <vector>
23
24 class LyXLex;
25 class Buffer;
26
27 ///
28 class MenuItem {
29 public:
30         /// The type of elements that can be in a menu
31         enum Kind {
32                 ///
33                 Command,
34                 ///
35                 Submenu,
36                 ///
37                 Separator,
38                 /** This is the list of last opened file,
39                     typically for the File menu. */
40                 Lastfiles,
41                 /** This is the list of opened Documents,
42                     typically for the Documents menu. */
43                 Documents,
44                 ///
45                 Toc,
46                 /** This is a list of viewable formats
47                     typically for the File->View menu. */
48                 ViewFormats,
49                 /** This is a list of updatable formats
50                     typically for the File->Update menu. */
51                 UpdateFormats,
52                 /** This is a list of exportable formats
53                     typically for the File->Export menu. */
54                 ExportFormats,
55                 /** This is a list of importable formats
56                     typically for the File->Export menu. */
57                 ImportFormats,
58                 /** This is the list of floats that we can
59                     insert a list for. */
60                 FloatListInsert,
61                 /** This is the list of floats that we can
62                     insert. */
63                 FloatInsert
64         };
65         /// Create a Command type MenuItem
66         MenuItem(Kind kind,
67                  string const & label = string(),
68                  string const & command = string(),
69                  bool optional = false);
70         MenuItem(Kind kind,
71                  string const & label,
72                  int action,
73                  bool optional = false)
74                 : kind_(kind), label_(label),
75                   action_(action), submenu_(), optional_(optional) {}
76
77         /// The label of a given menuitem
78         string const label() const;
79         /// The keyboard shortcut (usually underlined in the entry)
80         string const shortcut() const;
81         /// The complete label, with label and shortcut separated by a '|'
82         string const fulllabel() const { return label_;}
83         /// The kind of entry
84         Kind kind() const { return kind_; }
85         /// the action (if relevant)
86         int action() const { return action_; }
87         /// the description of the  submenu (if relevant)
88         string const & submenu() const { return submenu_; }
89         /// returns true if the entry should be ommited when disabled
90         bool optional() const { return optional_; }
91 private:
92         ///
93         Kind kind_;
94         ///
95         string label_;
96         ///
97         int action_;
98         ///
99         string submenu_;
100         ///
101         bool optional_;
102 };
103
104
105 ///
106 class Menu {
107 public:
108         ///
109         typedef std::vector<MenuItem> ItemList;
110         ///
111         typedef ItemList::const_iterator const_iterator;
112         ///
113         explicit Menu(string const & name = string())
114                 : name_(name) {}
115         ///
116         Menu & add(MenuItem const &);
117         ///
118         Menu & read(LyXLex &);
119         /// Expands some special entries of the menu
120         /** The entries with the following kind are expanded to a
121             sequence of Command MenuItems: Lastfiles, Documents,
122             ViewFormats, ExportFormats, UpdateFormats
123         */
124         void expand(Menu & tomenu, Buffer const *) const;
125         ///
126         string const & name() const { return name_; }
127         ///
128         bool empty() const { return items_.empty(); }
129         ///
130         ItemList::size_type size() const { return items_.size(); }
131         ///
132         bool hasSubmenu(string const &) const;
133         ///
134         const_iterator begin() const {
135                 return items_.begin();
136         }
137         ///
138         const_iterator end() const {
139                 return items_.end();
140         }
141
142         // Check whether the menu shortcuts are unique
143         void checkShortcuts() const;
144
145 private:
146         ///
147         ItemList items_;
148         ///
149         string name_;
150 };
151
152
153 ///
154 class MenuBackend {
155 public:
156         ///
157         typedef std::vector<Menu> MenuList;
158         ///
159         typedef MenuList::const_iterator const_iterator;
160         ///
161         void read(LyXLex &);
162         /// Set default values for menu structure.
163         void defaults();
164         ///
165         void add(Menu const &);
166         ///
167         bool hasMenu(string const &) const;
168         ///
169         Menu & getMenu (string const &);
170         ///
171         Menu const & getMenu (string const &) const;
172         ///
173         Menu const & getMenubar() const;
174         ///
175         bool empty() const { return menulist_.empty(); }
176         ///
177         const_iterator begin() const {
178                 return menulist_.begin();
179         }
180         ///
181         const_iterator end() const {
182                 return menulist_.end();
183         }
184 private:
185         ///
186         MenuList menulist_;
187         ///
188         Menu menubar_;
189 };
190
191 ///
192 extern MenuBackend menubackend;
193
194 #endif /* MENUBACKEND_H */