#ifndef LYXFUNC_H
#define LYXFUNC_H
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include "commandtags.h"
+#include "FuncStatus.h"
#include "kbsequence.h"
-#include "insets/lyxinset.h"
+#include "commandtags.h"
#include "LString.h"
+#include <boost/signals/trackable.hpp>
+
class LyXView;
+class LyXText;
+class FuncRequest;
+class BufferView;
+
-/** 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 {
- OK = 0, // No problem
- Unknown = 1,
- Disabled = 2, // Command cannot be executed
- ToggleOn = 4,
- ToggleOff = 8
- };
///
+ explicit
LyXFunc(LyXView *);
-
- /// LyX distpatcher, 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);
- /// A keyboard event is processed to execute a lyx action.
- int processKeyEvent(XEvent * ev);
+ /// LyX dispatcher, executes lyx actions.
+ void dispatch(FuncRequest const &, bool verbose = false);
+
+ /// Dispatch via a string argument
+ void dispatch(string const & s, bool verbose = false);
+
+ /// Dispatch via a pseudo action, also displaying shortcut/command name
+ void dispatch(int ac, bool verbose = false);
+
+ /// return the status bar state string
+ string const view_status_message();
+
+ ///
+ void processKeySym(LyXKeySymPtr 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;
///
- func_status getStatus(int ac) const;
-
+ FuncStatus getStatus(FuncRequest const & action) 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 key sequence
+ void handleKeyFunc(kb_action action);
+
private:
+ ///
+ BufferView * view() const;
+
///
LyXView * owner;
+
+ /// the last character added to the key sequence, in ISO encoded form
+ char encoded_last_key;
+
///
- static int psd_idx;
- ///
- kb_sequence keyseq;
- ///
- kb_sequence cancel_meta_seq;
+ kb_sequence keyseq;
///
- unsigned meta_fake_bit;
+ kb_sequence cancel_meta_seq;
///
- void moveCursorUpdate(bool selecting = false);
+ key_modifier::state meta_fake_bit;
+ ///
+ 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
+ /// 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;
- /// Command name and shortcut information
- string commandshortcut;
+ mutable string dispatch_buffer;
+ /** Buffer to store messages and result data from getStatus
+ */
+ mutable string status_buffer;
+
+ /// send a post-dispatch status message
+ void sendDispatchMessage(string const & msg, FuncRequest const & ev, bool verbose);
// I think the following should be moved to BufferView. (Asger)
///
- void MenuNew(bool fromTemplate);
+ void menuNew(string const & argument, bool fromTemplate);
///
- void MenuOpen();
+ void open(string const &);
///
- void doImportLaTeX(bool);
+ void doImport(string const &);
///
- void doImportASCII(bool);
-
+ void closeBuffer();
///
- void MenuInsertLyXFile(string const &);
-
+ void reloadBuffer();
///
- void CloseBuffer();
+ // This return or directly text (default) of getLyXText()
+ ///
+ LyXText * TEXT(bool) const;
///
- void reloadBuffer();
- /// This is the same for all lyxfunc objects
- static bool show_sc;
};
-
-
-/*-------------------- 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
projects / lyx.git / blobdiff