src/frontends/LyXView.h

   1 // -*- C++ -*-
   2 /**
   3  * \file LyXView.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 John Levon
   9  *
  10  * Full author contact details are available in file CREDITS.
  11  */
  12
  13 #ifndef LYXVIEW_H
  14 #define LYXVIEW_H
  15
  16 #include "support/strfwd.h"
  17
  18 namespace lyx {
  19
  20 namespace support { class FileName; }
  21
  22 class Buffer;
  23 class BufferView;
  24 class Cursor;
  25 class FuncStatus;
  26 class FuncRequest;
  27 class Inset;
  28
  29 namespace frontend {
  30
  31 /**
  32  * LyXView - main LyX window
  33  *
  34  * This class represents the main LyX window and provides
  35  * accessor functions to its content.
  36  *
  37  * The eventual intention is that LyX will support a number
  38  * of containing LyXViews. Currently a lot of code still
  39  * relies on there being a single top-level view.
  40  *
  41  * Additionally we would like to support multiple views
  42  * in a single LyXView.
  43  */
  44 class LyXView
  45 {
  46 public:
  47         ///
  48         virtual ~LyXView() {}
  49
  50         //@{ generic accessor functions
  51
  52         /// \return the currently selected buffer view.
  53         virtual BufferView * currentBufferView() = 0;
  54         virtual BufferView const * currentBufferView() const = 0;
  55         /// \return the current document buffer view.
  56         virtual BufferView * documentBufferView() = 0;
  57         virtual BufferView const * documentBufferView() const = 0;
  58         //@}
  59
  60         /// set a buffer to the current workarea.
  61         virtual void setBuffer(Buffer * b) = 0; ///< \c Buffer to set.
  62
  63         /// load a document into the current workarea.
  64         virtual Buffer * loadDocument(
  65                 support::FileName const &  name, ///< File to load.
  66                 bool tolastfiles = true  ///< append to the "Open recent" menu?
  67                 ) = 0;
  68
  69         /// display a message in the view
  70         virtual void message(docstring const &) = 0;
  71
  72         ///
  73         virtual bool getStatus(FuncRequest const & cmd, FuncStatus & flag) = 0;
  74         /// dispatch command.
  75         /// \return true if the \c FuncRequest has been dispatched.
  76         virtual bool dispatch(FuncRequest const & cmd) = 0;
  77
  78         ///
  79         virtual void restartCursor() = 0;
  80
  81         /// Update the completion popup and the inline completion state.
  82         /// If \c start is true, then a new completion might be started.
  83         /// If \c keep is true, an active completion will be kept active
  84         /// even though the cursor moved. The update flags of \c cur might
  85         /// be changed.
  86         virtual void updateCompletion(Cursor & cur, bool start, bool keep) = 0;
  87 };
  88
  89 } // namespace frontend
  90 } // namespace lyx
  91
  92 #endif // LYXVIEW_H