9 #include "commandtags.h"
10 #include "kbsequence.h"
11 #include "insets/lyxinset.h"
15 class auto_mem_buffer;
17 /** This class encapsulates all the LyX command operations.
18 This is the class of the LyX's "high level event handler".
19 Every user command is processed here, either invocated from
20 keyboard or from the GUI. All GUI objects, including buttons and
21 menus should use this class and never call kernel functions directly.
25 /// The status of a function.
29 Disabled = 2, // Command cannot be executed
37 /// LyX dispatcher, executes lyx actions.
38 string Dispatch(int action, char const * arg = 0);
40 /// The same but uses the name of a lyx command.
41 string Dispatch(string const & cmd);
43 /// Same again but for xtl buffers. Still looking for better idea.
44 bool Dispatch(int action, auto_mem_buffer &);
46 /// A keyboard event is processed to execute a lyx action.
47 int processKeyEvent(XEvent * ev);
50 func_status getStatus(int ac) const;
52 /// The last key was meta
53 bool wasMetaKey() const;
55 // These can't be global because are part of the
56 // internal state (ale970227)
57 /// Get the current keyseq string
58 string keyseqStr() const;
60 /// Is the key sequence uncomplete?
61 bool keyseqUncomplete() const;
63 /// get options for the current keyseq
64 string keyseqOptions() const;
66 /// True if lyxfunc reports an error
67 bool errorStat() const { return errorstat; }
68 /// Buffer to store result messages
69 void setMessage(string const & m);
70 /// Buffer to store result messages
71 void setErrorMessage(string const &) const;
72 /// Buffer to store result messages
73 string getMessage() const { return dispatch_buffer; }
74 /// Get next inset of this class from current cursor position
75 Inset * getInsetByCode(Inset::Code);
77 /// Should a hint message be displayed?
78 void setHintMessage(bool);
87 kb_sequence cancel_meta_seq;
89 unsigned meta_fake_bit;
91 void moveCursorUpdate(bool selecting = false);
93 void setupLocalKeymap();
95 kb_action lyx_dead_action;
97 kb_action lyx_calling_dead_action;
98 /// Error status, only Dispatch can change this flag
99 mutable bool errorstat;
101 /** Buffer to store messages and result data. Is there a
102 good reason to have this one as static in Dispatch? (Ale)
104 mutable string dispatch_buffer;
105 /// Command name and shortcut information
106 string commandshortcut;
108 // I think the following should be moved to BufferView. (Asger)
111 void MenuNew(bool fromTemplate);
117 void doImport(string const &);
118 void doImportHelper(string const &, string const &, string const &,
119 bool func(BufferView *, string const &) );
122 void MenuInsertLyXFile(string const &);
128 /// This is the same for all lyxfunc objects
133 /*-------------------- inlines --------------------------*/
136 bool LyXFunc::wasMetaKey() const
138 return (meta_fake_bit != 0);
143 string LyXFunc::keyseqStr() const
145 // Why not just remove this function
147 keyseq.print(text, true);
153 string LyXFunc::keyseqOptions() const
155 // Why not just remove this function
157 keyseq.printOptions(text);
163 bool LyXFunc::keyseqUncomplete() const
165 return (keyseq.length > 0);
170 void LyXFunc::setHintMessage(bool hm)
177 void operator|=(LyXFunc::func_status & fs, LyXFunc::func_status f)
179 fs = static_cast<LyXFunc::func_status>(fs | f);