src/frontends/WorkArea.h

   1 // -*- C++ -*-
   2 /**
   3  * \file WorkArea.h
   4  * Copyright 1995-2002 the LyX Team
   5  * Read the file COPYING
   6  *
   7  * \author unknown
   8  * \author John Levon <moz@compsoc.man.ac.uk>
   9  */
  10
  11 #ifndef WORKAREA_H
  12 #define WORKAREA_H
  13
  14 #include "frontends/mouse_state.h"
  15 #include "frontends/key_state.h"
  16 #include "frontends/LyXKeySym.h"
  17
  18 #include <boost/signals/signal0.hpp>
  19 #include <boost/signals/signal1.hpp>
  20 #include <boost/signals/signal2.hpp>
  21 #include <boost/signals/signal3.hpp>
  22
  23 #include <utility>
  24
  25 class Painter;
  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 LyXScreen class to update the
  32  * widget view of a document.
  33  */
  34 class WorkArea {
  35 public:
  36
  37         WorkArea() {}
  38
  39         virtual ~WorkArea() {}
  40
  41         /// return the painter object for this work area
  42         virtual Painter & getPainter() = 0;
  43
  44         /// return the width of the work area in pixels
  45         virtual int workWidth() const = 0;
  46         /// return the height of the work area in pixels
  47         virtual int workHeight() const = 0;
  48
  49         /**
  50          * Update the scrollbar.
  51          * @param height the total document height in pixels
  52          * @param pos the current position in the document, in pixels
  53          * @param line_height the line-scroll amount, in pixels
  54          */
  55         virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
  56
  57         // FIXME: this is an odd place to have it, but xforms needs it here ...
  58         /// a selection exists
  59         virtual void haveSelection(bool) const = 0;
  60         /// get the X clipboard contents
  61         virtual string const getClipboard() const = 0;
  62         /// fill the clipboard
  63         virtual void putClipboard(string const &) const = 0;
  64
  65         /// work area dimensions have changed
  66         boost::signal0<void> workAreaResize;
  67         /// the scrollbar has changed
  68         boost::signal1<void, int> scrollDocView;
  69         /// a key combination has been pressed
  70         boost::signal2<void, LyXKeySymPtr, key_modifier::state> workAreaKeyPress;
  71         /// a mouse button has been pressed
  72         boost::signal3<void, int, int, mouse_button::state> workAreaButtonPress;
  73         /// a mouse button has been released
  74         boost::signal3<void, int, int, mouse_button::state> workAreaButtonRelease;
  75         /// the mouse has moved
  76         boost::signal3<void, int, int, mouse_button::state> workAreaMotionNotify;
  77         /// a mouse button has been double-clicked
  78         boost::signal3<void, int, int, mouse_button::state> workAreaDoubleClick;
  79         /// a mouse button has been triple-clicked
  80         boost::signal3<void, int, int, mouse_button::state> workAreaTripleClick;
  81         /// emitted when an X client has requested our selection
  82         boost::signal0<void> selectionRequested;
  83         /// emitted when another X client has stolen our selection
  84         boost::signal0<void> selectionLost;
  85 };
  86
  87 #endif // WORKAREA_H