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);
55 /// we need one internall which is called from inside LyXAction and
56 /// can contain the string argument.
57 func_status getStatus(int ac) const;
58 func_status getStatus(int ac, string const & not_to_use_arg) const;
60 /// The last key was meta
61 bool wasMetaKey() const;
63 // These can't be global because are part of the
64 // internal state (ale970227)
65 /// Get the current keyseq string
66 string const keyseqStr() const;
68 /// Is the key sequence uncomplete?
69 bool keyseqUncomplete() const;
71 /// get options for the current keyseq
72 string const keyseqOptions() const;
74 /// True if lyxfunc reports an error
75 bool errorStat() const { return errorstat; }
76 /// Buffer to store result messages
77 void setMessage(string const & m);
78 /// Buffer to store result messages
79 void setErrorMessage(string const &) const;
80 /// Buffer to store result messages
81 string const getMessage() const { return dispatch_buffer; }
82 /// Handle a accented char keysequenze
83 void handleKeyFunc(kb_action action);
84 /// Should a hint message be displayed?
85 void setHintMessage(bool);
94 kb_sequence cancel_meta_seq;
96 unsigned meta_fake_bit;
98 void moveCursorUpdate(bool flag = true, bool selecting = false);
100 void setupLocalKeymap();
102 kb_action lyx_dead_action;
104 kb_action lyx_calling_dead_action;
105 /// Error status, only Dispatch can change this flag
106 mutable bool errorstat;
108 /** Buffer to store messages and result data. Is there a
109 good reason to have this one as static in Dispatch? (Ale)
111 mutable string dispatch_buffer;
112 /// Command name and shortcut information
113 string commandshortcut;
115 // I think the following should be moved to BufferView. (Asger)
118 void MenuNew(bool fromTemplate);
121 void Open(string const &);
124 void doImport(string const &);
131 // This return or directly text (default) of getLyXText()
133 LyXText * TEXT(bool) const;
135 // This is the same for all lyxfunc objects
140 /*-------------------- inlines --------------------------*/
143 bool LyXFunc::wasMetaKey() const
145 return (meta_fake_bit != 0);
150 string const LyXFunc::keyseqStr() const
152 // Why not just remove this function
154 keyseq.print(text, true);
160 string const LyXFunc::keyseqOptions() const
162 // Why not just remove this function
164 keyseq.printOptions(text);
170 bool LyXFunc::keyseqUncomplete() const
172 return (keyseq.length > 0);
177 void LyXFunc::setHintMessage(bool hm)
184 void operator|=(LyXFunc::func_status & fs, LyXFunc::func_status f)
186 fs = static_cast<LyXFunc::func_status>(fs | f);