// -*- 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 "kbsequence.h"
+#include "lfuns.h"
+
+#include <boost/shared_ptr.hpp>
+#include <boost/signals/trackable.hpp>
-#include "commandtags.h"
-#include "kbmap.h"
-#include "tex-accent.h"
-#include "LyXAction.h"
-#include "insets/lyxinset.h"
-#include "LString.h"
+
+class BufferView;
+class FuncRequest;
+class FuncStatus;
+class LyXKeySym;
+class LyXText;
class LyXView;
-/** 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:
///
- LyXFunc(LyXView*);
+ explicit LyXFunc(LyXView *);
+
+ /// LyX dispatcher, executes lyx actions.
+ void dispatch(FuncRequest const &);
+
+ /// return the status bar state string
+ std::string const viewStatusMessage();
+
+ ///
+ void processKeySym(LyXKeySymPtr key, key_modifier::state state);
+
///
- ~LyXFunc();
-
- /// 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, string const &arg = string());
-
-
- /// A keyboard event is processed to execute a lyx action.
- int processKeyEvent(XEvent *ev);
-
+ FuncStatus getStatus(FuncRequest const & action) const;
+
/// The last key was meta
- bool wasMetaKey();
-
- // These can't be global because are part of the internat state (ale970227)
- /// Get the current keyseq string
- string keyseqStr(int l = 190);
-
- /// Is the key sequence uncomplete?
- bool keyseqUncomplete();
-
- /// get options for the current keyseq
- string keyseqOptions(int l = 190);
-
- /// Returns the name of a funcion given a keyseq
- char const* getFunc(char*)
- { /* unimplemented */ return 0; }
-
- /// Return a string with the keybind to an action, if any
- char const* getKeybind(int)
- { /* unimplemented */ return 0; }
-
- /// 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 &);
- /// 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);
+ bool wasMetaKey() const;
+
+ /// 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);
private:
///
- LyXView *owner;
- ///
- static kb_func_table* lyx_func_table;
+ BufferView * view() const;
+
///
- static kb_func_table *lyx_func_args;
+ 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 setupLocalKeymap();
- ///
- kb_action lyx_dead_action;
- ///
- kb_action lyx_calling_dead_action;
- /// Error status, only Dispatch can change this flag
- bool errorstat;
-
- /** Buffer to store messages and result data. Is there a
- good reason to have this one as static in Dispatch? (Ale)
- */
- string dispatch_buffer;
- /// Command name and shortcut information
- string commandshortcut;
-
- // I think the following should be moved to BufferView. (Asger)
-
- ///
- void MenuNew(bool fromTemplate);
+ /// Error status, only Dispatch can change this flag
+ mutable bool errorstat;
- ///
- void MenuOpen();
+ /** Buffer to store messages and result data. Is there a
+ good reason to have this one as static in Dispatch? (Ale)
+ */
+ mutable std::string dispatch_buffer;
- ///
- void doImportLaTeX(bool);
+ /// 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 doImportASCII(bool);
-
+ void menuNew(std::string const & argument, bool fromTemplate);
///
- void MenuInsertLyXFile(string const &);
-
+ void open(std::string const &);
///
- void CloseBuffer();
+ void doImport(std::string const &);
///
- void reloadBuffer();
- /// This is the same for all lyxfunc objects
- static bool show_sc;
+ void closeBuffer();
};
-
-
-/*-------------------- inlines --------------------------*/
-
-inline
-bool LyXFunc::wasMetaKey()
-{
- return (meta_fake_bit != 0);
-}
-
-
-inline
-string LyXFunc::keyseqStr(int l)
-{
- char text[200];
- keyseq.print(text, l, true);
- string tmp(text);
- return tmp;
-}
-
-
-inline
-string LyXFunc::keyseqOptions(int l)
-{
- char text[200];
- keyseq.printOptions(text, l);
- string tmp(text);
- return tmp;
-}
-
-
-inline
-bool LyXFunc::keyseqUncomplete()
-{
- return (keyseq.length > 0);
-}
-
-inline
-void LyXFunc::setHintMessage(bool hm)
-{
- show_sc = hm;
-}
#endif
projects / lyx.git / blobdiff