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
  19 namespace lyx {
  20
  21 class BufferView;
  22 class KeySymbol;
  23
  24 namespace frontend {
  25
  26 /**
  27  * The work area class represents the widget that provides the
  28  * view onto a document. It is owned by the BufferView, and
  29  * is responsible for handing events back to its owning BufferView.
  30  * It works in concert with the BaseScreen class to update the
  31  * widget view of a document.
  32  */
  33 class WorkArea
  34 {
  35 public:
  36         ///
  37         WorkArea() {}
  38         ///
  39         virtual ~WorkArea() {}
  40
  41         /// redraw the screen, without using existing pixmap
  42         virtual void redraw() = 0;
  43
  44         /// Process Key pressed event.
  45         /// This needs to be public because it is accessed externally by GuiView.
  46         virtual void processKeySym(KeySymbol const & key, KeyModifier mod) = 0;
  47
  48         /// close this work area.
  49         /// Slot for Buffer::closing signal.
  50         virtual void close() = 0;
  51         /// This function is called when the buffer readonly status change.
  52         virtual void setReadOnly(bool) = 0;
  53
  54         /// Update window titles of all users.
  55         virtual void updateWindowTitle() = 0;
  56 };
  57
  58 } // namespace frontend
  59 } // namespace lyx
  60
  61 #endif // BASE_WORKAREA_H