src/LyXFunc.h

   1 // -*- C++ -*-
   2 /**
   3  * \file LyXFunc.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author Lars Gullik Bjønnes
   8  * \author Jean-Marc Lasgouttes
   9  * \author John Levon
  10  * \author André Pönitz
  11  *
  12  * Full author contact details are available in file CREDITS.
  13  */
  14
  15 #ifndef LYXFUNC_H
  16 #define LYXFUNC_H
  17
  18 #include "KeySequence.h"
  19 #include "lfuns.h"
  20 #include "TextClassPtr.h"
  21
  22 #include "support/docstring.h"
  23
  24 namespace lyx {
  25
  26 class Buffer;
  27 class BufferView;
  28 class FuncRequest;
  29 class FuncStatus;
  30 class KeySymbol;
  31 class Text;
  32
  33 namespace support {
  34 class FileName;
  35 }
  36
  37 namespace frontend {
  38 class LyXView;
  39 }
  40
  41 /** This class encapsulates all the LyX command operations.
  42     This is the class of the LyX's "high level event handler".
  43     Every user command is processed here, either invocated from
  44     keyboard or from the GUI. All GUI objects, including buttons and
  45     menus should use this class and never call kernel functions directly.
  46 */
  47 class LyXFunc
  48 {
  49 public:
  50         ///
  51         explicit LyXFunc();
  52
  53         /// LyX dispatcher, executes lyx actions.
  54         void dispatch(FuncRequest const &);
  55
  56         ///
  57         void setLyXView(frontend::LyXView * lv);
  58
  59         ///
  60         void initKeySequences(KeyMap * kb);
  61
  62         /// return the status bar state string
  63         docstring const viewStatusMessage();
  64
  65         ///
  66         void processKeySym(KeySymbol const & key, KeyModifier state);
  67
  68         ///
  69         FuncStatus getStatus(FuncRequest const & action) const;
  70
  71         /// The last key was meta
  72         bool wasMetaKey() const;
  73
  74         /// True if lyxfunc reports an error
  75         bool errorStat() const { return errorstat; }
  76         /// Buffer to store result messages
  77         void setMessage(docstring const & m) const;
  78         /// Buffer to store result messages
  79         void setErrorMessage(docstring const &) const;
  80         /// Buffer to store result messages
  81         docstring const getMessage() const { return dispatch_buffer; }
  82         /// Handle a accented char key sequence
  83         void handleKeyFunc(kb_action action);
  84         /// goto a bookmark
  85         /// openFile: whether or not open a file if the file is not opened
  86         /// switchToBuffer: whether or not switch to buffer if the buffer is
  87         ///             not the current buffer
  88         void gotoBookmark(unsigned int idx, bool openFile, bool switchToBuffer);
  89
  90         /// load a buffer into the current workarea.
  91         Buffer * loadAndViewFile(support::FileName const &  name, ///< File to load.
  92                 bool tolastfiles = true);  ///< append to the "Open recent" menu?
  93
  94 private:
  95         ///
  96         BufferView * view() const;
  97
  98         ///
  99         frontend::LyXView * lyx_view_;
 100
 101         /// the last character added to the key sequence, in UCS4 encoded form
 102         char_type encoded_last_key;
 103
 104         ///
 105         KeySequence keyseq;
 106         ///
 107         KeySequence cancel_meta_seq;
 108         ///
 109         KeyModifier meta_fake_bit;
 110
 111         /// Error status, only Dispatch can change this flag
 112         mutable bool errorstat;
 113
 114         /** Buffer to store messages and result data. Is there a
 115             good reason to have this one as static in Dispatch? (Ale)
 116         */
 117         mutable docstring dispatch_buffer;
 118
 119         /// send a post-dispatch status message
 120         void sendDispatchMessage(docstring const & msg,
 121                 FuncRequest const & ev);
 122
 123         // I think the following should be moved to BufferView. (Asger)
 124         ///
 125         void menuNew(std::string const & argument, bool fromTemplate);
 126         ///
 127         void open(std::string const &);
 128         ///
 129         void doImport(std::string const &);
 130         ///
 131         void closeBuffer();
 132         ///
 133         void reloadBuffer();
 134         ///
 135         bool ensureBufferClean(BufferView * bv);
 136         ///
 137         void updateLayout(TextClassPtr const & oldlayout, Buffer * buffer);
 138 };
 139
 140 /// Implementation is in LyX.cpp
 141 extern LyXFunc & theLyXFunc();
 142
 143 /// Implementation is in LyX.cpp
 144 extern FuncStatus getStatus(FuncRequest const & action);
 145
 146 /// Implementation is in LyX.cpp
 147 extern void dispatch(FuncRequest const & action);
 148
 149 } // namespace lyx
 150
 151 #endif