#pragma interface
#endif
-#include FORMS_H_LOCATION
-#include "commandtags.h"
+
+#include "commandtags.h" // for kb_action enum
+#include "FuncStatus.h"
#include "kbsequence.h"
-#include "insets/lyxinset.h"
#include "LString.h"
+#include "frontends/mouse_state.h"
+#include "frontends/key_state.h"
+
+#include <boost/signals/trackable.hpp>
+
+#include <X11/Xlib.h>
+
class LyXView;
-class auto_mem_buffer;
+class LyXText;
+
-/** This class encapsulates all the LyX command operations.
+/** This class encapsulates all the LyX command operations.
This is the class of the LyX's "high level event handler".
Every user command is processed here, either invocated from
keyboard or from the GUI. All GUI objects, including buttons and
menus should use this class and never call kernel functions directly.
*/
-class LyXFunc {
+class LyXFunc : public boost::signals::trackable {
public:
- /// The status of a function.
- enum func_status {
- /// No problem
- OK = 0,
- ///
- Unknown = 1,
- /// Command cannot be executed
- Disabled = 2,
- ///
- ToggleOn = 4,
- ///
- ToggleOff = 8
- };
///
explicit
LyXFunc(LyXView *);
-
+
/// LyX dispatcher, executes lyx actions.
- string Dispatch(int action, char const * arg = 0);
-
- /// The same but uses the name of a lyx command.
- string Dispatch(string const & cmd);
+ string const dispatch(kb_action ac, string argument = string());
- /// Same again but for xtl buffers. Still looking for better idea.
- bool Dispatch(int action, auto_mem_buffer &);
+ /// The same as dispatch, but also shows shortcuts and command
+ /// name in minibuffer if show_sc is true (more to come?)
+ void verboseDispatch(kb_action action,
+ string const & argument,
+ bool show_sc);
+
+ /// Same as above, using a pseudoaction as argument
+ void verboseDispatch(int ac, bool show_sc);
+
+ /// Same as above, when the command is provided as a string
+ void verboseDispatch(string const & s, bool show_sc);
-#if 0
- /// A keyboard event is processed to execute a lyx action.
- int processKeyEvent(XEvent * ev);
-#else
///
- int processKeySym(KeySym k, unsigned int state);
-#endif
+ void miniDispatch(string const & s);
+
+ ///
+ void initMiniBuffer();
+
///
- func_status getStatus(int ac) const;
-
+ void processKeySym(KeySym key, key_modifier::state state);
+
+ /// we need one internal which is called from inside LyXAction and
+ /// can contain the string argument.
+ FuncStatus getStatus(int ac) const;
+ ///
+ FuncStatus getStatus(kb_action action,
+ string const & argument = string()) const;
+
/// The last key was meta
bool wasMetaKey() const;
- // These can't be global because are part of the
- // internal state (ale970227)
- /// Get the current keyseq string
- string keyseqStr() const;
-
- /// Is the key sequence uncomplete?
- bool keyseqUncomplete() const;
-
- /// get options for the current keyseq
- string keyseqOptions() const;
-
- /// True if lyxfunc reports an error
- bool errorStat() const { return errorstat; }
- /// Buffer to store result messages
- void setMessage(string const & m);
- /// Buffer to store result messages
- void setErrorMessage(string const &) const;
- /// Buffer to store result messages
- string getMessage() const { return dispatch_buffer; }
- /// Get next inset of this class from current cursor position
- Inset * getInsetByCode(Inset::Code);
-
- /// Should a hint message be displayed?
- void setHintMessage(bool);
+ /// True if lyxfunc reports an error
+ bool errorStat() const { return errorstat; }
+ /// Buffer to store result messages
+ void setMessage(string const & m) const;
+ /// Buffer to store result messages
+ void setErrorMessage(string const &) const;
+ /// Buffer to store result messages from getStatus
+ void setStatusMessage(string const &) const;
+ /// Buffer to store result messages
+ string const getMessage() const { return dispatch_buffer; }
+ /// Buffer to store result messages
+ string const getStatusMessage() const { return status_buffer; }
+ /// Handle a accented char keysequenze
+ void handleKeyFunc(kb_action action);
+
private:
///
LyXView * owner;
///
static int psd_idx;
- ///
- kb_sequence keyseq;
- ///
- kb_sequence cancel_meta_seq;
///
- unsigned meta_fake_bit;
+ kb_sequence keyseq;
+ ///
+ kb_sequence cancel_meta_seq;
+ ///
+ key_modifier::state meta_fake_bit;
///
- void moveCursorUpdate(bool selecting = false);
+ void moveCursorUpdate(bool flag = true, bool selecting = false);
///
void setupLocalKeymap();
- ///
- kb_action lyx_dead_action;
- ///
- kb_action lyx_calling_dead_action;
- /// Error status, only Dispatch can change this flag
- mutable bool errorstat;
-
- /** Buffer to store messages and result data. Is there a
+ ///
+ kb_action lyx_dead_action;
+ ///
+ kb_action lyx_calling_dead_action;
+ /// Error status, only Dispatch can change this flag
+ mutable bool errorstat;
+
+ /** Buffer to store messages and result data. Is there a
good reason to have this one as static in Dispatch? (Ale)
*/
- mutable string dispatch_buffer;
+ mutable string dispatch_buffer;
+ /** Buffer to store messages and result data from getStatus
+ */
+ mutable string status_buffer;
/// Command name and shortcut information
string commandshortcut;
// I think the following should be moved to BufferView. (Asger)
///
- void MenuNew(bool fromTemplate);
+ void menuNew(bool fromTemplate);
///
- void MenuOpen();
+ void open(string const &);
///
void doImport(string const &);
- ///
- void doImportHelper(string const &, string const &, string const &,
- bool func(BufferView *, string const &) );
///
- void MenuInsertLyXFile(string const &);
-
- ///
- void CloseBuffer();
+ void closeBuffer();
///
void reloadBuffer();
- /// This is the same for all lyxfunc objects
- static bool show_sc;
+ ///
+ // This return or directly text (default) of getLyXText()
+ ///
+ LyXText * TEXT(bool) const;
+ ///
};
-
-
-/*-------------------- inlines --------------------------*/
-inline
-bool LyXFunc::wasMetaKey() const
-{
- return (meta_fake_bit != 0);
-}
-
-
-inline
-string LyXFunc::keyseqStr() const
-{
- // Why not just remove this function
- string text;
- keyseq.print(text, true);
- return text;
-}
+/*-------------------- inlines --------------------------*/
inline
-string LyXFunc::keyseqOptions() const
+bool LyXFunc::wasMetaKey() const
{
- // Why not just remove this function
- string text;
- keyseq.printOptions(text);
- return text;
-}
-
-
-inline
-bool LyXFunc::keyseqUncomplete() const
-{
- return (keyseq.length > 0);
+ return (meta_fake_bit != key_modifier::none);
}
-inline
-void LyXFunc::setHintMessage(bool hm)
-{
- show_sc = hm;
-}
-
-///
-inline
-void operator|=(LyXFunc::func_status & fs, LyXFunc::func_status f)
-{
- fs = static_cast<LyXFunc::func_status>(fs | f);
-}
-
#endif