src/ToolbarBackend.h

   1 // -*- C++ -*-
   2 /**
   3  * \file ToolbarBackend.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Jean-Marc Lasgouttes
   8  * \author John Levon
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef TOOLBAR_BACKEND_H
  14 #define TOOLBAR_BACKEND_H
  15
  16 #include "funcrequest.h"
  17
  18 #include <vector>
  19
  20
  21 namespace lyx {
  22
  23
  24 class LyXLex;
  25
  26
  27 ///
  28 class ToolbarBackend {
  29 public:
  30         /// The special toolbar actions
  31         enum ItemType {
  32                 /// the command buffer
  33                 MINIBUFFER = -3,
  34                 /// adds space between buttons in the toolbar
  35                 SEPARATOR = -2,
  36                 /// a special combox insead of a button
  37                 LAYOUTS = -1,
  38         };
  39
  40         /// action, tooltip
  41         typedef std::pair<FuncRequest, docstring> Item;
  42
  43         /// the toolbar items
  44         typedef std::vector<Item> Items;
  45
  46         /// toolbar flags
  47         enum Flags {
  48                 ON = 1, //< always shown
  49                 OFF = 2, //< never shown
  50                 MATH = 4, //< shown when in math
  51                 TABLE = 8, //< shown when in table
  52                 TOP = 16, //< show at top
  53                 BOTTOM = 32, //< show at bottom
  54                 LEFT = 64, //< show at left
  55                 RIGHT = 128, //< show at right
  56                 REVIEW = 256 //< shown when change tracking is enabled
  57         };
  58
  59         /// a toolbar
  60         struct Toolbar {
  61                 /// toolbar name
  62                 std::string name;
  63                 /// toolbar GUI name
  64                 std::string gui_name;
  65                 /// toolbar contents
  66                 Items items;
  67                 /// flags
  68                 Flags flags;
  69         };
  70
  71         typedef std::vector<Toolbar> Toolbars;
  72
  73         typedef Items::const_iterator item_iterator;
  74
  75         ToolbarBackend();
  76
  77         /// iterator for all toolbars
  78         Toolbars::const_iterator begin() const { return usedtoolbars.begin(); }
  79
  80         Toolbars::const_iterator end() const { return usedtoolbars.end(); }
  81
  82         /// read a toolbar from the file
  83         void read(LyXLex &);
  84
  85         /// read the used toolbars
  86         void readToolbars(LyXLex &);
  87
  88         /// return a full path of an XPM for the given action
  89         static std::string const getIcon(FuncRequest const &);
  90
  91 private:
  92         /// add the given lfun with tooltip if relevant
  93         void add(Toolbar & tb, FuncRequest const &,
  94                  docstring const & tooltip = docstring());
  95
  96         /// all the toolbars
  97         Toolbars toolbars;
  98
  99         /// toolbars listed
 100         Toolbars usedtoolbars;
 101 };
 102
 103 /// The global instance
 104 extern ToolbarBackend toolbarbackend;
 105
 106
 107
 108 } // namespace lyx
 109
 110 #endif // TOOLBAR_BACKEND_H