src/frontends/WorkArea.h

   1 // -*- C++ -*-
   2 /**
   3  * \file WorkArea.h
   4  * This file is part of LyX, the document processor.
   5  * Licence details can be found in the file COPYING.
   6  *
   7  * \author unknown
   8  * \author John Levon
   9  * \author Abdelrazak Younes
  10  *
  11  * Full author contact details are available in file CREDITS.
  12  */
  13
  14 #ifndef BASE_WORKAREA_H
  15 #define BASE_WORKAREA_H
  16
  17 #include "frontends/KeyModifier.h"
  18 #include "frontends/LyXView.h"
  19
  20 namespace lyx {
  21
  22 class BufferView;
  23 class KeySymbol;
  24
  25 namespace frontend {
  26
  27 /**
  28  * The work area class represents the widget that provides the
  29  * view onto a document. It is owned by the BufferView, and
  30  * is responsible for handing events back to its owning BufferView.
  31  * It works in concert with the BaseScreen class to update the
  32  * widget view of a document.
  33  */
  34 class WorkArea
  35 {
  36 public:
  37         ///
  38         WorkArea() : lyx_view_(0) {}
  39         ///
  40         virtual ~WorkArea() {}
  41
  42         /// redraw the screen, without using existing pixmap
  43         virtual void redraw() = 0;
  44
  45         /// close this work area.
  46         /// Slot for Buffer::closing signal.
  47         virtual void close() = 0;
  48         /// This function is called when the buffer readonly status change.
  49         virtual void setReadOnly(bool) = 0;
  50
  51         /// Update window titles of all users.
  52         virtual void updateWindowTitle() = 0;
  53
  54 private:
  55
  56         LyXView * lyx_view_;
  57 };
  58
  59 } // namespace frontend
  60 } // namespace lyx
  61
  62 #endif // BASE_WORKAREA_H