9 #include "commandtags.h"
10 #include "kbsequence.h"
11 #include "insets/lyxinset.h"
16 /** This class encapsulates all the LyX command operations.
17 This is the class of the LyX's "high level event handler".
18 Every user command is processed here, either invocated from
19 keyboard or from the GUI. All GUI objects, including buttons and
20 menus should use this class and never call kernel functions directly.
24 /// The status of a function.
28 Disabled = 2, // Command cannot be executed
36 /// LyX dispatcher, executes lyx actions.
37 string Dispatch(int action, char const * arg = 0);
39 /// The same but uses the name of a lyx command.
40 string Dispatch(string const & cmd);
42 /// A keyboard event is processed to execute a lyx action.
43 int processKeyEvent(XEvent * ev);
46 func_status getStatus(int ac) const;
48 /// The last key was meta
49 bool wasMetaKey() const;
51 // These can't be global because are part of the
52 // internal state (ale970227)
53 /// Get the current keyseq string
54 string keyseqStr() const;
56 /// Is the key sequence uncomplete?
57 bool keyseqUncomplete() const;
59 /// get options for the current keyseq
60 string keyseqOptions() const;
62 /// True if lyxfunc reports an error
63 bool errorStat() const { return errorstat; }
64 /// Buffer to store result messages
65 void setMessage(string const & m);
66 /// Buffer to store result messages
67 void setErrorMessage(string const &) const;
68 /// Buffer to store result messages
69 string getMessage() const { return dispatch_buffer; }
70 /// Get next inset of this class from current cursor position
71 Inset * getInsetByCode(Inset::Code);
73 /// Should a hint message be displayed?
74 void setHintMessage(bool);
84 kb_sequence cancel_meta_seq;
86 unsigned meta_fake_bit;
88 void moveCursorUpdate(bool selecting = false);
90 void setupLocalKeymap();
92 kb_action lyx_dead_action;
94 kb_action lyx_calling_dead_action;
95 /// Error status, only Dispatch can change this flag
96 mutable bool errorstat;
98 /** Buffer to store messages and result data. Is there a
99 good reason to have this one as static in Dispatch? (Ale)
101 mutable string dispatch_buffer;
102 /// Command name and shortcut information
103 string commandshortcut;
105 // I think the following should be moved to BufferView. (Asger)
108 void MenuNew(bool fromTemplate);
114 void doImport(string const &);
115 void doImportHelper(string const &, string const &, string const &,
116 bool func(BufferView *, string const &) );
119 void MenuInsertLyXFile(string const &);
125 /// This is the same for all lyxfunc objects
130 /*-------------------- inlines --------------------------*/
133 bool LyXFunc::wasMetaKey() const
135 return (meta_fake_bit != 0);
140 string LyXFunc::keyseqStr() const
142 // Why not just remove this function
144 keyseq.print(text, true);
150 string LyXFunc::keyseqOptions() const
152 // Why not just remove this function
154 keyseq.printOptions(text);
160 bool LyXFunc::keyseqUncomplete() const
162 return (keyseq.length > 0);
167 void LyXFunc::setHintMessage(bool hm)
174 void operator|=(LyXFunc::func_status & fs, LyXFunc::func_status f)
176 fs = static_cast<LyXFunc::func_status>(fs | f);