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 #include "LString.h"
  18
  19 #include <boost/shared_ptr.hpp>
  20
  21 #include <vector>
  22
  23 #include "FuncStatus.h"
  24
  25 class LyXLex;
  26 class LyXView;
  27 class Menu;
  28
  29 ///
  30 class MenuItem {
  31 public:
  32         /// The type of elements that can be in a menu
  33         enum Kind {
  34                 ///
  35                 Command,
  36                 ///
  37                 Submenu,
  38                 ///
  39                 Separator,
  40                 /** This is the list of last opened file,
  41                     typically for the File menu. */
  42                 Lastfiles,
  43                 /** This is the list of opened Documents,
  44                     typically for the Documents menu. */
  45                 Documents,
  46                 ///
  47                 Toc,
  48                 /** This is a list of viewable formats
  49                     typically for the File->View menu. */
  50                 ViewFormats,
  51                 /** This is a list of updatable formats
  52                     typically for the File->Update menu. */
  53                 UpdateFormats,
  54                 /** This is a list of exportable formats
  55                     typically for the File->Export menu. */
  56                 ExportFormats,
  57                 /** This is a list of importable formats
  58                     typically for the File->Export menu. */
  59                 ImportFormats,
  60                 /** This is the list of floats that we can
  61                     insert a list for. */
  62                 FloatListInsert,
  63                 /** This is the list of floats that we can
  64                     insert. */
  65                 FloatInsert
  66         };
  67         /// Create a Command type MenuItem
  68         MenuItem(Kind kind,
  69                  string const & label = string(),
  70                  string const & command = string(),
  71                  bool optional = false);
  72         MenuItem(Kind kind,
  73                  string const & label,
  74                  int action,
  75                  bool optional = false);
  76
  77         /// This one is just to please boost::shared_ptr<>
  78         ~MenuItem();
  79         /// The label of a given menuitem
  80         string const label() const;
  81         /// The keyboard shortcut (usually underlined in the entry)
  82         string const shortcut() const;
  83         /// The complete label, with label and shortcut separated by a '|'
  84         string const fulllabel() const { return label_;}
  85         /// The kind of entry
  86         Kind kind() const { return kind_; }
  87         /// the action (if relevant)
  88         int action() const { return action_; }
  89         /// returns true if the entry should be ommited when disabled
  90         bool optional() const { return optional_; }
  91         /// returns the status of the lfun associated with this entry
  92         FuncStatus const & status() const { return status_; }
  93         /// returns the status of the lfun associated with this entry
  94         FuncStatus & status() { return status_; }
  95         /// returns the status of the lfun associated with this entry
  96         void status(FuncStatus const & status) { status_ = status; }
  97         /// returns the binding associated to this action
  98         string const binding() const;
  99         /// the description of the  submenu (if relevant)
 100         string const & submenuname() const { return submenuname_; }
 101         /// set the description of the  submenu
 102         void submenuname(string const & name) { submenuname_ = name; }
 103         ///
 104         Menu * submenu() const { return submenu_.get(); }
 105         ///
 106         void submenu(Menu * menu);
 107
 108 private:
 109         //friend class MenuBackend;
 110         ///
 111         Kind kind_;
 112         ///
 113         string label_;
 114         ///
 115         int action_;
 116         ///
 117         string submenuname_;
 118         ///
 119         bool optional_;
 120         ///
 121         FuncStatus status_;
 122         ///
 123         boost::shared_ptr<Menu> submenu_;
 124 };
 125
 126
 127 ///
 128 class Menu {
 129 public:
 130         ///
 131         typedef std::vector<MenuItem> ItemList;
 132         ///
 133         typedef ItemList::const_iterator const_iterator;
 134         ///
 135         typedef ItemList::size_type size_type;
 136         ///
 137         explicit Menu(string const & name = string())
 138                 : name_(name) {}
 139         ///
 140         Menu & add(MenuItem const &, LyXView const * view = 0);
 141         ///
 142         Menu & read(LyXLex &);
 143         ///
 144         string const & name() const { return name_; }
 145         ///
 146         bool empty() const { return items_.empty(); }
 147         ///
 148         ItemList::size_type size() const { return items_.size(); }
 149         ///
 150         bool hasSubmenu(string const &) const;
 151         ///
 152         const_iterator begin() const {
 153                 return items_.begin();
 154         }
 155         ///
 156         const_iterator end() const {
 157                 return items_.end();
 158         }
 159
 160         // Check whether the menu shortcuts are unique
 161         void checkShortcuts() const;
 162
 163 private:
 164         friend class MenuBackend;
 165         ///
 166         ItemList items_;
 167         ///
 168         string name_;
 169 };
 170
 171
 172 ///
 173 class MenuBackend {
 174 public:
 175         ///
 176         typedef std::vector<Menu> MenuList;
 177         ///
 178         typedef MenuList::const_iterator const_iterator;
 179         ///
 180         void read(LyXLex &);
 181         ///
 182         void add(Menu const &);
 183         ///
 184         bool hasMenu(string const &) const;
 185         ///
 186         Menu & getMenu (string const &);
 187         ///
 188         Menu const & getMenu (string const &) const;
 189         ///
 190         Menu const & getMenubar() const;
 191         ///
 192         bool empty() const { return menulist_.empty(); }
 193         /// Expands some special entries of the menu
 194         /** The entries with the following kind are expanded to a
 195             sequence of Command MenuItems: Lastfiles, Documents,
 196             ViewFormats, ExportFormats, UpdateFormats
 197         */
 198         void expand(Menu const & frommenu, Menu & tomenu,
 199                     LyXView const *) const;
 200         ///
 201         const_iterator begin() const {
 202                 return menulist_.begin();
 203         }
 204         ///
 205         const_iterator end() const {
 206                 return menulist_.end();
 207         }
 208 private:
 209         ///
 210         MenuList menulist_;
 211         ///
 212         Menu menubar_;
 213 };
 214
 215 ///
 216 extern MenuBackend menubackend;
 217
 218 #endif /* MENUBACKEND_H */