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.
31 /// Command cannot be executed
42 /// LyX dispatcher, executes lyx actions.
43 string Dispatch(int action, char const * arg = 0);
45 /// The same but uses the name of a lyx command.
46 string Dispatch(string const & cmd);
48 /// Same again but for xtl buffers. Still looking for better idea.
49 bool Dispatch(int action, auto_mem_buffer &);
51 /// A keyboard event is processed to execute a lyx action.
52 int processKeyEvent(XEvent * ev);
55 func_status getStatus(int ac) const;
57 /// The last key was meta
58 bool wasMetaKey() const;
60 // These can't be global because are part of the
61 // internal state (ale970227)
62 /// Get the current keyseq string
63 string keyseqStr() const;
65 /// Is the key sequence uncomplete?
66 bool keyseqUncomplete() const;
68 /// get options for the current keyseq
69 string keyseqOptions() const;
71 /// True if lyxfunc reports an error
72 bool errorStat() const { return errorstat; }
73 /// Buffer to store result messages
74 void setMessage(string const & m);
75 /// Buffer to store result messages
76 void setErrorMessage(string const &) const;
77 /// Buffer to store result messages
78 string getMessage() const { return dispatch_buffer; }
79 /// Get next inset of this class from current cursor position
80 Inset * getInsetByCode(Inset::Code);
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 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 &);
124 void doImportHelper(string const &, string const &, string const &,
125 bool func(BufferView *, string const &) );
128 void MenuInsertLyXFile(string const &);
134 /// This is the same for all lyxfunc objects
139 /*-------------------- inlines --------------------------*/
142 bool LyXFunc::wasMetaKey() const
144 return (meta_fake_bit != 0);
149 string LyXFunc::keyseqStr() const
151 // Why not just remove this function
153 keyseq.print(text, true);
159 string LyXFunc::keyseqOptions() const
161 // Why not just remove this function
163 keyseq.printOptions(text);
169 bool LyXFunc::keyseqUncomplete() const
171 return (keyseq.length > 0);
176 void LyXFunc::setHintMessage(bool hm)
183 void operator|=(LyXFunc::func_status & fs, LyXFunc::func_status f)
185 fs = static_cast<LyXFunc::func_status>(fs | f);