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 #include <boost/shared_ptr.hpp>
  24
  25 class LyXLex;
  26 class Buffer;
  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                 : kind_(kind), label_(label),
  77                   action_(action), submenuname_(), optional_(optional) {}
  78
  79         /// This one is just to please boost::shared_ptr<>
  80         ~MenuItem();
  81         /// The label of a given menuitem
  82         string const label() const;
  83         /// The keyboard shortcut (usually underlined in the entry)
  84         string const shortcut() const;
  85         /// The complete label, with label and shortcut separated by a '|'
  86         string const fulllabel() const { return label_;}
  87         /// The kind of entry
  88         Kind kind() const { return kind_; }
  89         /// the action (if relevant)
  90         int action() const { return action_; }
  91         /// the description of the  submenu (if relevant)
  92         string const & submenuname() const { return submenuname_; }
  93         /// returns true if the entry should be ommited when disabled
  94         bool optional() const { return optional_; }
  95         ///
  96         Menu & submenu() const { return *submenu_.get(); }
  97 private:
  98         friend class MenuBackend;
  99         ///
 100         Kind kind_;
 101         ///
 102         string label_;
 103         ///
 104         int action_;
 105         ///
 106         string submenuname_;
 107         ///
 108         bool optional_;
 109         ///
 110         boost::shared_ptr<Menu> submenu_;
 111 };
 112
 113
 114 ///
 115 class Menu {
 116 public:
 117         ///
 118         typedef std::vector<MenuItem> ItemList;
 119         ///
 120         typedef ItemList::const_iterator const_iterator;
 121         ///
 122         explicit Menu(string const & name = string())
 123                 : name_(name) {}
 124         ///
 125         Menu & add(MenuItem const &);
 126         ///
 127         Menu & read(LyXLex &);
 128         ///
 129         string const & name() const { return name_; }
 130         ///
 131         bool empty() const { return items_.empty(); }
 132         ///
 133         ItemList::size_type size() const { return items_.size(); }
 134         ///
 135         bool hasSubmenu(string const &) const;
 136         ///
 137         const_iterator begin() const {
 138                 return items_.begin();
 139         }
 140         ///
 141         const_iterator end() const {
 142                 return items_.end();
 143         }
 144
 145         // Check whether the menu shortcuts are unique
 146         void checkShortcuts() const;
 147
 148 private:
 149         ///
 150         ItemList items_;
 151         ///
 152         string name_;
 153 };
 154
 155
 156 ///
 157 class MenuBackend {
 158 public:
 159         ///
 160         typedef std::vector<Menu> MenuList;
 161         ///
 162         typedef MenuList::const_iterator const_iterator;
 163         ///
 164         void read(LyXLex &);
 165         /// Set default values for menu structure.
 166         void defaults();
 167         ///
 168         void add(Menu const &);
 169         ///
 170         bool hasMenu(string const &) const;
 171         ///
 172         Menu & getMenu (string const &);
 173         ///
 174         Menu const & getMenu (string const &) const;
 175         ///
 176         Menu const & getMenubar() const;
 177         ///
 178         bool empty() const { return menulist_.empty(); }
 179         /// Expands some special entries of the menu
 180         /** The entries with the following kind are expanded to a
 181             sequence of Command MenuItems: Lastfiles, Documents,
 182             ViewFormats, ExportFormats, UpdateFormats
 183         */
 184         void expand(Menu const & frommenu, Menu & tomenu,
 185                     Buffer const *) const;
 186         ///
 187         const_iterator begin() const {
 188                 return menulist_.begin();
 189         }
 190         ///
 191         const_iterator end() const {
 192                 return menulist_.end();
 193         }
 194 private:
 195         ///
 196         MenuList menulist_;
 197         ///
 198         Menu menubar_;
 199 };
 200
 201 ///
 202 extern MenuBackend menubackend;
 203
 204 #endif /* MENUBACKEND_H */