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         LyXView() {}
  49         ///
  50         virtual ~LyXView() {}
  51         ///
  52         virtual int id() const = 0;
  53
  54         /// show busy cursor
  55         virtual void setBusy(bool) = 0;
  56
  57         //@{ generic accessor functions
  58
  59         /// \return the currently selected buffer view.
  60         virtual BufferView * view() = 0;
  61         /// \return the current document buffer view.
  62         virtual BufferView * documentBufferView() = 0;
  63
  64         /// \return the buffer currently selected in this window
  65         virtual Buffer * buffer() = 0;
  66         virtual Buffer const * buffer() const = 0;
  67
  68         /// \return the document buffer in this window
  69         virtual Buffer * documentBuffer() = 0;
  70         virtual Buffer const * documentBuffer() const = 0;
  71
  72         /// set a buffer to the current workarea.
  73         virtual void setBuffer(Buffer * b) = 0; ///< \c Buffer to set.
  74         ///
  75         virtual bool closeBuffer() = 0;
  76         ///
  77         virtual bool closeBufferAll() = 0;
  78         ///
  79         virtual bool hasFocus() const = 0;
  80
  81         /// load a document into the current workarea.
  82         virtual Buffer * loadDocument(
  83                 support::FileName const &  name, ///< File to load.
  84                 bool tolastfiles = true  ///< append to the "Open recent" menu?
  85                 ) = 0;
  86         ///
  87         virtual void newDocument(std::string const & filename,
  88                 bool fromTemplate) = 0;
  89
  90         //@}
  91
  92         /// display a message in the view
  93         virtual void message(docstring const &) = 0;
  94
  95         ///
  96         virtual bool getStatus(FuncRequest const & cmd, FuncStatus & flag) = 0;
  97         /// dispatch command.
  98         /// \return true if the \c FuncRequest has been dispatched.
  99         virtual bool dispatch(FuncRequest const & cmd) = 0;
 100
 101         ///
 102         virtual void restartCursor() = 0;
 103
 104         /// Update the completion popup and the inline completion state.
 105         /// If \c start is true, then a new completion might be started.
 106         /// If \c keep is true, an active completion will be kept active
 107         /// even though the cursor moved. The update flags of \c cur might
 108         /// be changed.
 109         virtual void updateCompletion(Cursor & cur, bool start, bool keep) = 0;
 110
 111 private:
 112         /// noncopyable
 113         LyXView(LyXView const &);
 114         void operator=(LyXView const &);
 115 };
 116
 117 } // namespace frontend
 118 } // namespace lyx
 119
 120 #endif // LYXVIEW_H