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
  23 class LyXLex;
  24 class Buffer;
  25 class Menu;
  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 elements available
  59                  * for insertion into document. */
  60                 CharStyles,
  61                 /** This is the list of floats that we can
  62                     insert a list for. */
  63                 FloatListInsert,
  64                 /** This is the list of floats that we can
  65                     insert. */
  66                 FloatInsert,
  67                 /** This is the list of selections that can
  68                     be pasted. */
  69                 PasteRecent,
  70                 /** Available branches in document */
  71                 Branches
  72         };
  73
  74         explicit MenuItem(Kind kind);
  75
  76         MenuItem(Kind kind,
  77                  lyx::docstring const & label,
  78                  lyx::docstring const & submenu = lyx::docstring(),
  79                  bool optional = false);
  80
  81         MenuItem(Kind kind,
  82                  lyx::docstring const & label,
  83                  FuncRequest const & func,
  84                  bool optional = false);
  85
  86         /// This one is just to please boost::shared_ptr<>
  87         ~MenuItem();
  88         /// The label of a given menuitem
  89         lyx::docstring const label() const;
  90         /// The keyboard shortcut (usually underlined in the entry)
  91         lyx::docstring const shortcut() const;
  92         /// The complete label, with label and shortcut separated by a '|'
  93         lyx::docstring const fulllabel() const { return label_;}
  94         /// The kind of entry
  95         Kind kind() const { return kind_; }
  96         /// the action (if relevant)
  97         FuncRequest const & func() const { return func_; }
  98         /// returns true if the entry should be ommited when disabled
  99         bool optional() const { return optional_; }
 100         /// returns the status of the lfun associated with this entry
 101         FuncStatus const & status() const { return status_; }
 102         /// returns the status of the lfun associated with this entry
 103         FuncStatus & status() { return status_; }
 104         /// returns the status of the lfun associated with this entry
 105         void status(FuncStatus const & status) { status_ = status; }
 106         /// returns the binding associated to this action
 107         lyx::docstring const binding() const;
 108         /// the description of the  submenu (if relevant)
 109         lyx::docstring const & submenuname() const { return submenuname_; }
 110         /// set the description of the  submenu
 111         void submenuname(lyx::docstring const & name) { submenuname_ = name; }
 112         ///
 113         Menu * submenu() const { return submenu_.get(); }
 114         ///
 115         void submenu(Menu * menu);
 116
 117 private:
 118         //friend class MenuBackend;
 119         ///
 120         Kind kind_;
 121         ///
 122         lyx::docstring label_;
 123         ///
 124         FuncRequest func_;
 125         ///
 126         lyx::docstring submenuname_;
 127         ///
 128         bool optional_;
 129         ///
 130         FuncStatus status_;
 131         ///
 132         boost::shared_ptr<Menu> submenu_;
 133 };
 134
 135
 136 ///
 137 class Menu {
 138 public:
 139         ///
 140         typedef std::vector<MenuItem> ItemList;
 141         ///
 142         typedef ItemList::const_iterator const_iterator;
 143         ///
 144         typedef ItemList::size_type size_type;
 145         ///
 146         explicit Menu(lyx::docstring const & name = lyx::docstring())
 147                 : name_(name) {}
 148         /// Add the menu item unconditionally
 149         Menu & add(MenuItem const &);
 150         /// Checks the associated FuncRequest status before adding the
 151         /// menu item.
 152         Menu & addWithStatusCheck(MenuItem const &);
 153         ///
 154         Menu & read(LyXLex &);
 155         ///
 156         lyx::docstring const & name() const { return name_; }
 157         ///
 158         bool empty() const { return items_.empty(); }
 159         /// Clear the menu content.
 160         void clear() { items_.clear(); }
 161         ///
 162         ItemList::size_type size() const { return items_.size(); }
 163         ///
 164         MenuItem const & operator[](size_type) const;
 165         ///
 166         bool hasFunc(FuncRequest const &) const;
 167         ///
 168         const_iterator begin() const {
 169                 return items_.begin();
 170         }
 171         ///
 172         const_iterator end() const {
 173                 return items_.end();
 174         }
 175
 176         // Check whether the menu shortcuts are unique
 177         void checkShortcuts() const;
 178
 179 private:
 180         friend class MenuBackend;
 181         ///
 182         ItemList items_;
 183         ///
 184         lyx::docstring name_;
 185 };
 186
 187
 188 ///
 189 class MenuBackend {
 190 public:
 191         ///
 192         typedef std::vector<Menu> MenuList;
 193         ///
 194         typedef MenuList::const_iterator const_iterator;
 195         ///
 196         typedef MenuList::iterator iterator;
 197         ///
 198         MenuBackend() : specialmenu_(0) {}
 199         ///
 200         void read(LyXLex &);
 201         ///
 202         void add(Menu const &);
 203         ///
 204         bool hasMenu(lyx::docstring const &) const;
 205         ///
 206         Menu & getMenu(lyx::docstring const &);
 207         ///
 208         Menu const & getMenu(lyx::docstring const &) const;
 209         ///
 210         Menu const & getMenubar() const;
 211         ///
 212         bool empty() const { return menulist_.empty(); }
 213         /** This defines a menu whose entries list the FuncRequests
 214             will be removed by expand() in other menus. This is used by
 215             the Qt/Mac code
 216         */
 217         void specialMenu(lyx::docstring const &);
 218         /// Expands some special entries of the menu
 219         /** The entries with the following kind are expanded to a
 220             sequence of Command MenuItems: Lastfiles, Documents,
 221             ViewFormats, ExportFormats, UpdateFormats, Branches
 222         */
 223         void expand(Menu const & frommenu, Menu & tomenu,
 224                     Buffer const *) const;
 225         ///
 226         const_iterator begin() const {
 227                 return menulist_.begin();
 228         }
 229         ///
 230         iterator begin() {
 231                 return menulist_.begin();
 232         }
 233         ///
 234         const_iterator end() const {
 235                 return menulist_.end();
 236         }
 237         ///
 238         iterator end() {
 239                 return menulist_.end();
 240         }
 241 private:
 242         ///
 243         MenuList menulist_;
 244         ///
 245         Menu menubar_;
 246         ///
 247         Menu * specialmenu_;
 248 };
 249
 250 ///
 251 extern MenuBackend menubackend;
 252
 253 #endif /* MENUBACKEND_H */