// -*- 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
-#ifdef __GNUG__
-#pragma interface
-#endif
-
-#include FORMS_H_LOCATION
-#include "commandtags.h"
#include "kbsequence.h"
-#include "insets/lyxinset.h"
-#include "LString.h"
+#include "lfuns.h"
+#include <boost/shared_ptr.hpp>
+#include <boost/signals/trackable.hpp>
+
+
+class BufferView;
+class FuncRequest;
+class FuncStatus;
+class LyXKeySym;
+class LyXText;
class LyXView;
-class auto_mem_buffer;
-/** 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 *);
-
+ 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);
+ void dispatch(FuncRequest const &);
+
+ /// return the status bar state string
+ std::string const viewStatusMessage();
- /// Same again but for xtl buffers. Still looking for better idea.
- bool Dispatch(int action, auto_mem_buffer &);
+ ///
+ void processKeySym(LyXKeySymPtr key, key_modifier::state state);
///
- int processKeySym(KeySym k, unsigned int state);
+ FuncStatus getStatus(FuncRequest const & action) const;
- /// we need one internall which is called from inside LyXAction and
- /// can contain the string argument.
- func_status getStatus(int ac) const;
- func_status getStatus(int ac, string const & not_to_use_arg) 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; }
- /// Handle a accented char keysequenze
+ /// True if lyxfunc reports an error
+ bool errorStat() const { return errorstat; }
+ /// Buffer to store result messages
+ void setMessage(std::string const & m) const;
+ /// Buffer to store result messages
+ void setErrorMessage(std::string const &) const;
+ /// Buffer to store result messages
+ std::string const getMessage() const { return dispatch_buffer; }
+ /// Handle a accented char key sequence
void handleKeyFunc(kb_action action);
- /// Should a hint message be displayed?
- void setHintMessage(bool);
+
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 flag = true, bool selecting = false);
+ key_modifier::state meta_fake_bit;
///
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;
-
- // I think the following should be moved to BufferView. (Asger)
-
- ///
- void MenuNew(bool fromTemplate);
-
- ///
- void Open(string const &);
+ mutable std::string dispatch_buffer;
- ///
- void doImport(string const &);
+ /// send a post-dispatch status message
+ void sendDispatchMessage(std::string const & msg,
+ FuncRequest const & ev);
+ // I think the following should be moved to BufferView. (Asger)
///
- void CloseBuffer();
- ///
- void reloadBuffer();
+ void menuNew(std::string const & argument, bool fromTemplate);
///
- // This return or directly text (default) of getLyXText()
+ void open(std::string const &);
///
- LyXText * TEXT(bool) const;
+ void doImport(std::string const &);
///
- // This is the same for all lyxfunc objects
- static bool show_sc;
+ void closeBuffer();
};
-
-
-/*-------------------- 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;
-}
-
-
-inline
-string const LyXFunc::keyseqOptions() const
-{
- // Why not just remove this function
- string text;
- keyseq.printOptions(text);
- return text;
-}
-
-
-inline
-bool LyXFunc::keyseqUncomplete() const
-{
- return (keyseq.length > 0);
-}
-
-
-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