]> git.lyx.org Git - lyx.git/blobdiff - src/lyxfunc.h
Extracted from r14281
[lyx.git] / src / lyxfunc.h
index 1482b175cb5cd591c24f3bbab848f1500391a76d..c01819217625db02f9b9cde38751973d92decbd9 100644 (file)
@@ -1,18 +1,33 @@
 // -*- C++ -*-
+/**
+ * \file lyxfunc.h
+ * This file is part of LyX, the document processor.
+ * Licence details can be found in the file COPYING.
+ *
+ * \author Lars Gullik Bjønnes
+ * \author Jean-Marc Lasgouttes
+ * \author John Levon
+ * \author André Pönitz
+ *
+ * Full author contact details are available in file CREDITS.
+ */
+
 #ifndef LYXFUNC_H
 #define LYXFUNC_H
 
-#include "FuncStatus.h"
 #include "kbsequence.h"
-#include "commandtags.h"
-#include "LString.h"
+#include "lfuns.h"
 
+#include <boost/shared_ptr.hpp>
 #include <boost/signals/trackable.hpp>
 
-class LyXView;
-class LyXText;
-class FuncRequest;
+
 class BufferView;
+class FuncRequest;
+class FuncStatus;
+class LyXKeySym;
+class LyXText;
+class LyXView;
 
 
 /** This class encapsulates all the LyX command operations.
@@ -24,27 +39,17 @@ class BufferView;
 class LyXFunc : public boost::signals::trackable {
 public:
        ///
-       explicit
-       LyXFunc(LyXView *);
+       explicit LyXFunc(LyXView *);
 
        /// 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);
+       void dispatch(FuncRequest const &);
 
        /// return the status bar state string
-       string const view_status_message();
+       std::string const viewStatusMessage();
 
        ///
        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;
        ///
        FuncStatus getStatus(FuncRequest const & action) const;
 
@@ -54,15 +59,11 @@ public:
        /// True if lyxfunc reports an error
        bool errorStat() const { return errorstat; }
        /// Buffer to store result messages
-       void setMessage(string const & m) const;
+       void setMessage(std::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;
+       void setErrorMessage(std::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; }
+       std::string const getMessage() const { return dispatch_buffer; }
        /// Handle a accented char key sequence
        void handleKeyFunc(kb_action action);
 
@@ -83,8 +84,6 @@ private:
        ///
        key_modifier::state meta_fake_bit;
        ///
-       void moveCursorUpdate(bool flag = true, bool selecting = false);
-       ///
        void setupLocalKeymap();
        /// Error status, only Dispatch can change this flag
        mutable bool errorstat;
@@ -92,44 +91,21 @@ private:
        /** 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;
-       /** Buffer to store messages and result data from getStatus
-       */
-       mutable string status_buffer;
+       mutable std::string dispatch_buffer;
 
        /// send a post-dispatch status message
-       void sendDispatchMessage(string const & msg, FuncRequest const & ev, bool verbose);
+       void sendDispatchMessage(std::string const & msg,
+               FuncRequest const & ev);
 
        // I think the following should be moved to BufferView. (Asger)
-
        ///
-       void menuNew(string const & argument, bool fromTemplate);
-
+       void menuNew(std::string const & argument, bool fromTemplate);
        ///
-       void open(string const &);
-
+       void open(std::string const &);
        ///
-       void doImport(string const &);
-
+       void doImport(std::string const &);
        ///
        void closeBuffer();
-       ///
-       void reloadBuffer();
-       ///
-       //  This return or directly text (default) of getLyXText()
-       ///
-       LyXText * TEXT(bool) const;
-       ///
 };
 
-
-/*--------------------  inlines  --------------------------*/
-
-inline
-bool LyXFunc::wasMetaKey() const
-{
-       return (meta_fake_bit != key_modifier::none);
-}
-
-
 #endif