9 #include FORMS_H_LOCATION
10 #include "commandtags.h"
11 #include "kbsequence.h"
12 #include "insets/lyxinset.h"
16 class auto_mem_buffer;
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.
26 /// The status of a function.
32 /// Command cannot be executed
43 /// LyX dispatcher, executes lyx actions.
44 string const Dispatch(int action, string const & arg = string());
46 /// The same but uses the name of a lyx command.
47 string const Dispatch(string const & cmd);
49 /// Same again but for xtl buffers. Still looking for better idea.
50 bool Dispatch(int action, auto_mem_buffer &);
53 int processKeySym(KeySym k, unsigned int state);
56 func_status getStatus(int ac) const;
58 /// The last key was meta
59 bool wasMetaKey() const;
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;
66 /// Is the key sequence uncomplete?
67 bool keyseqUncomplete() const;
69 /// get options for the current keyseq
70 string const keyseqOptions() const;
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);
92 kb_sequence cancel_meta_seq;
94 unsigned meta_fake_bit;
96 void moveCursorUpdate(bool flag = true, bool selecting = false);
98 void setupLocalKeymap();
100 kb_action lyx_dead_action;
102 kb_action lyx_calling_dead_action;
103 /// Error status, only Dispatch can change this flag
104 mutable bool errorstat;
106 /** Buffer to store messages and result data. Is there a
107 good reason to have this one as static in Dispatch? (Ale)
109 mutable string dispatch_buffer;
110 /// Command name and shortcut information
111 string commandshortcut;
113 // I think the following should be moved to BufferView. (Asger)
116 void MenuNew(bool fromTemplate);
122 void doImport(string const &);
129 // This return or directly text (default) of getLyXText()
131 LyXText * TEXT(bool) const;
133 // This is the same for all lyxfunc objects
138 /*-------------------- inlines --------------------------*/
141 bool LyXFunc::wasMetaKey() const
143 return (meta_fake_bit != 0);
148 string const LyXFunc::keyseqStr() const
150 // Why not just remove this function
152 keyseq.print(text, true);
158 string const LyXFunc::keyseqOptions() const
160 // Why not just remove this function
162 keyseq.printOptions(text);
168 bool LyXFunc::keyseqUncomplete() const
170 return (keyseq.length > 0);
175 void LyXFunc::setHintMessage(bool hm)
182 void operator|=(LyXFunc::func_status & fs, LyXFunc::func_status f)
184 fs = static_cast<LyXFunc::func_status>(fs | f);