]> git.lyx.org Git - lyx.git/blobdiff - src/lyxfunc.h
fix typo that put too many include paths for most people
[lyx.git] / src / lyxfunc.h
index 6942650e1906291412a33bab54609e0619353d68..ec8898c242102c5607fd1a27bf6d83bb6475184f 100644 (file)
@@ -10,7 +10,7 @@
 #include <sigc++/signal_system.h>
 
 #include "commandtags.h" // for kb_action enum
-#include "func_status.h"
+#include "FuncStatus.h"
 #include "kbsequence.h"
 #include "LString.h"
 
@@ -18,7 +18,7 @@ class LyXView;
 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
@@ -29,81 +29,85 @@ public:
        ///
        explicit
        LyXFunc(LyXView *);
-    
+
        /// LyX dispatcher, executes lyx actions.
-       string const dispatch(int action, string const & arg = string());
-                        
-       /// The same but uses the name of a lyx command.
-       string const dispatch(string const & cmd);
+       string const dispatch(kb_action ac, string argument = string());
+
+       /// 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);
 
        ///
-       void miniDispatch(string const & cmd);
+       void miniDispatch(string const & s);
 
        ///
        void initMiniBuffer();
-               
+
        ///
        void processKeySym(KeySym k, unsigned int state);
 
-       /// we need one internall which is called from inside LyXAction and
+       /// we need one internal which is called from inside LyXAction and
        /// can contain the string argument.
-       func_status::value_type getStatus(int ac) const;
+       FuncStatus getStatus(int ac) const;
        ///
-       func_status::value_type getStatus(int ac, 
-                                         string const & not_to_use_arg) 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 const keyseqStr() const;
-
-       /// Is the key sequence uncomplete?
-       bool keyseqUncomplete() const;
-
-       /// get options for the current keyseq
-       string const 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 const getMessage() const { return dispatch_buffer; }
+       /// 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);
-       /// Should a hint message be displayed?
-       void setHintMessage(bool);
+
 private:
        ///
        LyXView * owner;
        ///
        static int psd_idx;
-       ///
-       kb_sequence keyseq;
-       ///
-       kb_sequence cancel_meta_seq;
+       ///
+       kb_sequence keyseq;
+       ///
+       kb_sequence cancel_meta_seq;
        ///
        unsigned 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
+       ///
+       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;
 
@@ -127,51 +131,16 @@ private:
        ///
        LyXText * TEXT(bool) const;
        ///
-       //  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 const LyXFunc::keyseqStr() const
-{
-       // Why not just remove this function
-       string text;
-       keyseq.print(text, true);
-       return text;
-} 
 
+/*--------------------  inlines  --------------------------*/
 
 inline
-string const 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 != 0);
 }
 
 
-inline
-void LyXFunc::setHintMessage(bool hm) 
-{ 
-       show_sc = hm;
-}
-
 #endif