src/lyxfunc.h

   1 // -*- C++ -*-
   2 #ifndef LYXFUNC_H
   3 #define LYXFUNC_H
   4
   5 #ifdef __GNUG__
   6 #pragma interface
   7 #endif
   8
   9 #include FORMS_H_LOCATION
  10 #include "commandtags.h"
  11 #include "kbsequence.h"
  12 #include "insets/lyxinset.h"
  13 #include "LString.h"
  14
  15 class LyXView;
  16 class auto_mem_buffer;
  17
  18 /** This class encapsulates all the LyX command operations.
  19     This is the class of the LyX's "high level event handler".
  20     Every user command is processed here, either invocated from
  21     keyboard or from the GUI. All GUI objects, including buttons and
  22     menus should use this class and never call kernel functions directly.
  23 */
  24 class LyXFunc {
  25 public:
  26         /// The status of a function.
  27         enum func_status {
  28                 /// No problem
  29                 OK = 0,
  30                 ///
  31                 Unknown = 1,
  32                 /// Command cannot be executed
  33                 Disabled = 2,
  34                 ///
  35                 ToggleOn = 4,
  36                 ///
  37                 ToggleOff = 8
  38         };
  39         ///
  40         explicit
  41         LyXFunc(LyXView *);
  42
  43         /// LyX dispatcher, executes lyx actions.
  44         string const Dispatch(int action, string const & arg = string());
  45
  46         /// The same but uses the name of a lyx command.
  47         string const Dispatch(string const & cmd);
  48
  49         /// Same again but for xtl buffers.  Still looking for better idea.
  50         bool Dispatch(int action, auto_mem_buffer &);
  51
  52         ///
  53         int processKeySym(KeySym k, unsigned int state);
  54
  55         ///
  56         func_status getStatus(int ac) const;
  57
  58         /// The last key was meta
  59         bool wasMetaKey() const;
  60
  61         // These can't be global because are part of the
  62         // internal state (ale970227)
  63         /// Get the current keyseq string
  64         string const keyseqStr() const;
  65
  66         /// Is the key sequence uncomplete?
  67         bool keyseqUncomplete() const;
  68
  69         /// get options for the current keyseq
  70         string const keyseqOptions() const;
  71
  72         /// True if lyxfunc reports an error
  73         bool errorStat() const { return errorstat; }
  74         /// Buffer to store result messages
  75         void setMessage(string const & m);
  76         /// Buffer to store result messages
  77         void setErrorMessage(string const &) const;
  78         /// Buffer to store result messages
  79         string const getMessage() const { return dispatch_buffer; }
  80         /// Handle a accented char keysequenze
  81         void handleKeyFunc(kb_action action);
  82         /// Should a hint message be displayed?
  83         void setHintMessage(bool);
  84 private:
  85         ///
  86         LyXView * owner;
  87         ///
  88         static int psd_idx;
  89         ///
  90         kb_sequence keyseq;
  91         ///
  92         kb_sequence cancel_meta_seq;
  93         ///
  94         unsigned meta_fake_bit;
  95         ///
  96         void moveCursorUpdate(bool flag = true, bool selecting = false);
  97         ///
  98         void setupLocalKeymap();
  99         ///
 100         kb_action lyx_dead_action;
 101         ///
 102         kb_action lyx_calling_dead_action;
 103         /// Error status, only Dispatch can change this flag
 104         mutable bool errorstat;
 105
 106         /** Buffer to store messages and result data. Is there a
 107             good reason to have this one as static in Dispatch? (Ale)
 108         */
 109         mutable string dispatch_buffer;
 110         /// Command name and shortcut information
 111         string commandshortcut;
 112
 113         // I think the following should be moved to BufferView. (Asger)
 114
 115         ///
 116         void MenuNew(bool fromTemplate);
 117
 118         ///
 119         void MenuOpen();
 120
 121         ///
 122         void doImport(string const &);
 123
 124         ///
 125         void CloseBuffer();
 126         ///
 127         void reloadBuffer();
 128         ///
 129         //  This return or directly text (default) of getLyXText()
 130         ///
 131         LyXText * TEXT(bool) const;
 132         ///
 133         //  This is the same for all lyxfunc objects
 134         static bool show_sc;
 135 };
 136
 137
 138 /*--------------------  inlines  --------------------------*/
 139
 140 inline
 141 bool LyXFunc::wasMetaKey() const
 142 {
 143         return (meta_fake_bit != 0);
 144 }
 145
 146
 147 inline
 148 string const LyXFunc::keyseqStr() const
 149 {
 150         // Why not just remove this function
 151         string text;
 152         keyseq.print(text, true);
 153         return text;
 154 }
 155
 156
 157 inline
 158 string const LyXFunc::keyseqOptions() const
 159 {
 160         // Why not just remove this function
 161         string text;
 162         keyseq.printOptions(text);
 163         return text;
 164 }
 165
 166
 167 inline
 168 bool LyXFunc::keyseqUncomplete() const
 169 {
 170         return (keyseq.length > 0);
 171 }
 172
 173
 174 inline
 175 void LyXFunc::setHintMessage(bool hm)
 176 {
 177         show_sc = hm;
 178 }
 179
 180 ///
 181 inline
 182 void operator|=(LyXFunc::func_status & fs, LyXFunc::func_status f)
 183 {
 184         fs = static_cast<LyXFunc::func_status>(fs | f);
 185 }
 186
 187 #endif