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 /// Get next inset of this class from current cursor position
81 Inset * getInsetByCode(Inset::Code);
83 /// Should a hint message be displayed?
84 void setHintMessage(bool);
93 kb_sequence cancel_meta_seq;
95 unsigned meta_fake_bit;
97 void moveCursorUpdate(bool selecting = false);
99 void setupLocalKeymap();
101 kb_action lyx_dead_action;
103 kb_action lyx_calling_dead_action;
104 /// Error status, only Dispatch can change this flag
105 mutable bool errorstat;
107 /** Buffer to store messages and result data. Is there a
108 good reason to have this one as static in Dispatch? (Ale)
110 mutable string dispatch_buffer;
111 /// Command name and shortcut information
112 string commandshortcut;
114 // I think the following should be moved to BufferView. (Asger)
117 void MenuNew(bool fromTemplate);
123 void doImport(string const &);
125 void MenuInsertLyXFile(string const &);
131 /// This is the same for all lyxfunc objects
136 /*-------------------- inlines --------------------------*/
139 bool LyXFunc::wasMetaKey() const
141 return (meta_fake_bit != 0);
146 string const LyXFunc::keyseqStr() const
148 // Why not just remove this function
150 keyseq.print(text, true);
156 string const LyXFunc::keyseqOptions() const
158 // Why not just remove this function
160 keyseq.printOptions(text);
166 bool LyXFunc::keyseqUncomplete() const
168 return (keyseq.length > 0);
173 void LyXFunc::setHintMessage(bool hm)
180 void operator|=(LyXFunc::func_status & fs, LyXFunc::func_status f)
182 fs = static_cast<LyXFunc::func_status>(fs | f);