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 LyXView;
  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                  std::string const & label,
  78                  std::string const & command = std::string(),
  79                  bool optional = false);
  80
  81         MenuItem(Kind kind,
  82                  std::string 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         std::string const label() const;
  90         /// The keyboard shortcut (usually underlined in the entry)
  91         std::string const shortcut() const;
  92         /// The complete label, with label and shortcut separated by a '|'
  93         std::string 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         std::string const binding() const;
 108         /// the description of the  submenu (if relevant)
 109         std::string const & submenuname() const { return submenuname_; }
 110         /// set the description of the  submenu
 111         void submenuname(std::string 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         std::string label_;
 123         ///
 124         FuncRequest func_;
 125         ///
 126         std::string 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(std::string const & name = std::string())
 147                 : name_(name) {}
 148         ///
 149         Menu & add(MenuItem const &, LyXView const * view = 0);
 150         ///
 151         Menu & read(LyXLex &);
 152         ///
 153         std::string const & name() const { return name_; }
 154         ///
 155         bool empty() const { return items_.empty(); }
 156         ///
 157         ItemList::size_type size() const { return items_.size(); }
 158         ///
 159         bool hasSubmenu(std::string const &) const;
 160         ///
 161         const_iterator begin() const {
 162                 return items_.begin();
 163         }
 164         ///
 165         const_iterator end() const {
 166                 return items_.end();
 167         }
 168
 169         // Check whether the menu shortcuts are unique
 170         void checkShortcuts() const;
 171
 172 private:
 173         friend class MenuBackend;
 174         ///
 175         ItemList items_;
 176         ///
 177         std::string name_;
 178 };
 179
 180
 181 ///
 182 class MenuBackend {
 183 public:
 184         ///
 185         typedef std::vector<Menu> MenuList;
 186         ///
 187         typedef MenuList::const_iterator const_iterator;
 188         ///
 189         void read(LyXLex &);
 190         ///
 191         void add(Menu const &);
 192         ///
 193         bool hasMenu(std::string const &) const;
 194         ///
 195         Menu & getMenu(std::string const &);
 196         ///
 197         Menu const & getMenu(std::string const &) const;
 198         ///
 199         Menu const & getMenubar() const;
 200         ///
 201         bool empty() const { return menulist_.empty(); }
 202         /// Expands some special entries of the menu
 203         /** The entries with the following kind are expanded to a
 204             sequence of Command MenuItems: Lastfiles, Documents,
 205             ViewFormats, ExportFormats, UpdateFormats, Branches
 206         */
 207         void expand(Menu const & frommenu, Menu & tomenu,
 208                     LyXView const *) const;
 209         ///
 210         const_iterator begin() const {
 211                 return menulist_.begin();
 212         }
 213         ///
 214         const_iterator end() const {
 215                 return menulist_.end();
 216         }
 217 private:
 218         ///
 219         MenuList menulist_;
 220         ///
 221         Menu menubar_;
 222 };
 223
 224 ///
 225 extern MenuBackend menubackend;
 226
 227 #endif /* MENUBACKEND_H */