src/MenuBackend.h

   1 // -*- C++ -*-
   2 /**
   3  * \file MenuBackend.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef MENUBACKEND_H
  14 #define MENUBACKEND_H
  15
  16 #include "FuncStatus.h"
  17 #include "FuncRequest.h"
  18
  19 #include <boost/shared_ptr.hpp>
  20
  21 #include <vector>
  22 #include <stack>
  23
  24
  25 namespace lyx {
  26
  27 class Lexer;
  28 class Buffer;
  29 class Menu;
  30
  31 ///
  32 class MenuItem {
  33 public:
  34         /// The type of elements that can be in a menu
  35         enum Kind {
  36                 ///
  37                 Command,
  38                 ///
  39                 Submenu,
  40                 ///
  41                 Separator,
  42                 /** This is the list of last opened file,
  43                     typically for the File menu. */
  44                 Lastfiles,
  45                 /** This is the list of opened Documents,
  46                     typically for the Documents menu. */
  47                 Documents,
  48                 /** This is the bookmarks */
  49                 Bookmarks,
  50                 ///
  51                 Toc,
  52                 /** This is a list of viewable formats
  53                     typically for the File->View menu. */
  54                 ViewFormats,
  55                 /** This is a list of updatable formats
  56                     typically for the File->Update menu. */
  57                 UpdateFormats,
  58                 /** This is a list of exportable formats
  59                     typically for the File->Export menu. */
  60                 ExportFormats,
  61                 /** This is a list of importable formats
  62                     typically for the File->Export menu. */
  63                 ImportFormats,
  64                 /** This is the list of elements available
  65                  * for insertion into document. */
  66                 CharStyles,
  67                 /** This is the list of user-configurable
  68                 insets to insert into document */
  69                 Custom,
  70                 /** This is the list of XML elements to
  71                 insert into the document */
  72                 Elements,
  73                 /** This is the list of floats that we can
  74                     insert a list for. */
  75                 FloatListInsert,
  76                 /** This is the list of floats that we can
  77                     insert. */
  78                 FloatInsert,
  79                 /** This is the list of selections that can
  80                     be pasted. */
  81                 PasteRecent,
  82                 /** toolbars */
  83                 Toolbars,
  84                 /** Available branches in document */
  85                 Branches
  86         };
  87
  88         explicit MenuItem(Kind kind);
  89
  90         MenuItem(Kind kind,
  91                  docstring const & label,
  92                  docstring const & submenu = docstring(),
  93                  bool optional = false);
  94
  95         MenuItem(Kind kind,
  96                  docstring const & label,
  97                  FuncRequest const & func,
  98                  bool optional = false);
  99
 100         /// This one is just to please boost::shared_ptr<>
 101         ~MenuItem();
 102         /// The label of a given menuitem
 103         docstring const label() const;
 104         /// The keyboard shortcut (usually underlined in the entry)
 105         docstring const shortcut() const;
 106         /// The complete label, with label and shortcut separated by a '|'
 107         docstring const fulllabel() const { return label_;}
 108         /// The kind of entry
 109         Kind kind() const { return kind_; }
 110         /// the action (if relevant)
 111         FuncRequest const & func() const { return func_; }
 112         /// returns true if the entry should be ommited when disabled
 113         bool optional() const { return optional_; }
 114         /// returns the status of the lfun associated with this entry
 115         FuncStatus const & status() const { return status_; }
 116         /// returns the status of the lfun associated with this entry
 117         FuncStatus & status() { return status_; }
 118         /// returns the status of the lfun associated with this entry
 119         void status(FuncStatus const & status) { status_ = status; }
 120         ///returns the binding associated to this action.
 121         docstring const binding() const;
 122         /// the description of the  submenu (if relevant)
 123         docstring const & submenuname() const { return submenuname_; }
 124         /// set the description of the  submenu
 125         void submenuname(docstring const & name) { submenuname_ = name; }
 126         ///
 127         Menu * submenu() const { return submenu_.get(); }
 128         ///
 129         void submenu(Menu * menu);
 130
 131 private:
 132         //friend class MenuBackend;
 133         ///
 134         Kind kind_;
 135         ///
 136         docstring label_;
 137         ///
 138         FuncRequest func_;
 139         ///
 140         docstring submenuname_;
 141         ///
 142         bool optional_;
 143         ///
 144         FuncStatus status_;
 145         ///
 146         boost::shared_ptr<Menu> submenu_;
 147 };
 148
 149
 150 ///
 151 class Menu {
 152 public:
 153         ///
 154         typedef std::vector<MenuItem> ItemList;
 155         ///
 156         typedef ItemList::const_iterator const_iterator;
 157         ///
 158         typedef ItemList::size_type size_type;
 159         ///
 160         explicit Menu(docstring const & name = docstring()) : name_(name) {}
 161         /// Add the menu item unconditionally
 162         Menu & add(MenuItem const &);
 163         /// Checks the associated FuncRequest status before adding the
 164         /// menu item.
 165         Menu & addWithStatusCheck(MenuItem const &);
 166         ///
 167         Menu & read(Lexer &);
 168         ///
 169         docstring const & name() const { return name_; }
 170         ///
 171         bool empty() const { return items_.empty(); }
 172         /// Clear the menu content.
 173         void clear() { items_.clear(); }
 174         ///
 175         ItemList::size_type size() const { return items_.size(); }
 176         ///
 177         MenuItem const & operator[](size_type) const;
 178         ///
 179         bool hasFunc(FuncRequest const &) const;
 180         ///
 181         const_iterator begin() const { return items_.begin(); }
 182         ///
 183         const_iterator end() const { return items_.end(); }
 184
 185         // Check whether the menu shortcuts are unique
 186         void checkShortcuts() const;
 187
 188         // search for func in this menu iteratively, and put menu
 189         // names in a stack.
 190         bool searchFunc(FuncRequest & func, std::stack<docstring> & names) const;
 191
 192 private:
 193         friend class MenuBackend;
 194         ///
 195         ItemList items_;
 196         ///
 197         docstring name_;
 198 };
 199
 200
 201 ///
 202 class MenuBackend {
 203 public:
 204         ///
 205         typedef std::vector<Menu> MenuList;
 206         ///
 207         typedef MenuList::const_iterator const_iterator;
 208         ///
 209         typedef MenuList::iterator iterator;
 210         ///
 211         MenuBackend() {}
 212         ///
 213         void read(Lexer &);
 214         ///
 215         void add(Menu const &);
 216         ///
 217         bool hasMenu(docstring const &) const;
 218         ///
 219         Menu & getMenu(docstring const &);
 220         ///
 221         Menu const & getMenu(docstring const &) const;
 222         ///
 223         Menu const & getMenubar() const;
 224         ///
 225         bool empty() const { return menulist_.empty(); }
 226         /** This defines a menu whose entries list the FuncRequests
 227             that will be removed by expand() in other menus. This is
 228             used by the Qt/Mac code
 229         */
 230         void specialMenu(Menu const &);
 231         ///
 232         Menu const & specialMenu() { return specialmenu_; }
 233
 234         /// Expands some special entries of the menu
 235         /** The entries with the following kind are expanded to a
 236             sequence of Command MenuItems: Lastfiles, Documents,
 237             ViewFormats, ExportFormats, UpdateFormats, Branches
 238         */
 239         void expand(Menu const & frommenu, Menu & tomenu,
 240                     Buffer const *) const;
 241         ///
 242         const_iterator begin() const { return menulist_.begin(); }
 243         ///
 244         iterator begin() { return menulist_.begin(); }
 245         ///
 246         const_iterator end() const { return menulist_.end(); }
 247         ///
 248         iterator end() { return menulist_.end(); }
 249
 250 private:
 251         ///
 252         MenuList menulist_;
 253         ///
 254         Menu menubar_;
 255         ///
 256         Menu specialmenu_;
 257 };
 258
 259 } // namespace lyx
 260
 261 #endif // MENUBACKEND_H