4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
7 * \author Lars Gullik Bjønnes
8 * \author Jean-Marc Lasgouttes
10 * \author André Pönitz
12 * Full author contact details are available in file CREDITS.
18 #include "KeySequence.h"
20 #include "TextClassPtr.h"
22 #include "support/docstring.h"
41 /** This class encapsulates all the LyX command operations.
42 This is the class of the LyX's "high level event handler".
43 Every user command is processed here, either invocated from
44 keyboard or from the GUI. All GUI objects, including buttons and
45 menus should use this class and never call kernel functions directly.
53 /// LyX dispatcher, executes lyx actions.
54 void dispatch(FuncRequest const &);
57 void setLyXView(frontend::LyXView * lv);
60 void initKeySequences(KeyMap * kb);
62 /// return the status bar state string
63 docstring const viewStatusMessage();
66 void processKeySym(KeySymbol const & key, KeyModifier state);
69 FuncStatus getStatus(FuncRequest const & action) const;
71 /// The last key was meta
72 bool wasMetaKey() const;
74 /// True if lyxfunc reports an error
75 bool errorStat() const { return errorstat; }
76 /// Buffer to store result messages
77 void setMessage(docstring const & m) const;
78 /// Buffer to store result messages
79 void setErrorMessage(docstring const &) const;
80 /// Buffer to store result messages
81 docstring const getMessage() const { return dispatch_buffer; }
82 /// Handle a accented char key sequence
83 void handleKeyFunc(kb_action action);
85 /// openFile: whether or not open a file if the file is not opened
86 /// switchToBuffer: whether or not switch to buffer if the buffer is
87 /// not the current buffer
88 void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
90 /// load a buffer into the current workarea.
91 Buffer * loadAndViewFile(support::FileName const & name, ///< File to load.
92 bool tolastfiles = true); ///< append to the "Open recent" menu?
94 /// cursor x position before dispatch started
95 int cursorBeforeDispatchX() const {
96 return cursorPosBeforeDispatchX_;
98 /// cursor y position before dispatch started
99 int cursorBeforeDispatchY() const {
100 return cursorPosBeforeDispatchY_;
105 BufferView * view() const;
108 frontend::LyXView * lyx_view_;
110 /// the last character added to the key sequence, in UCS4 encoded form
111 char_type encoded_last_key;
116 KeySequence cancel_meta_seq;
118 KeyModifier meta_fake_bit;
120 /// cursor position before dispatch started
121 int cursorPosBeforeDispatchX_;
122 int cursorPosBeforeDispatchY_;
124 /// Error status, only Dispatch can change this flag
125 mutable bool errorstat;
127 /** Buffer to store messages and result data. Is there a
128 good reason to have this one as static in Dispatch? (Ale)
130 mutable docstring dispatch_buffer;
132 /// send a post-dispatch status message
133 void sendDispatchMessage(docstring const & msg,
134 FuncRequest const & ev);
137 void open(std::string const &);
139 void doImport(std::string const &);
145 bool ensureBufferClean(BufferView * bv);
147 void updateLayout(TextClassPtr const & oldlayout, Buffer * buffer);
150 /// Implementation is in LyX.cpp
151 extern LyXFunc & theLyXFunc();
153 /// Implementation is in LyX.cpp
154 extern FuncStatus getStatus(FuncRequest const & action);
156 /// Implementation is in LyX.cpp
157 extern void dispatch(FuncRequest const & action);