4 * Copyright 1995-2002 the LyX Team
5 * Read the file COPYING
8 * \author John Levon <moz@compsoc.man.ac.uk>
14 #include "frontends/mouse_state.h"
15 #include "frontends/key_state.h"
16 #include "frontends/LyXKeySym.h"
18 #include <boost/signals/signal0.hpp>
19 #include <boost/signals/signal1.hpp>
20 #include <boost/signals/signal2.hpp>
21 #include <boost/signals/signal3.hpp>
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.
39 virtual ~WorkArea() {}
41 /// return the painter object for this work area
42 virtual Painter & getPainter() = 0;
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;
50 virtual void redraw() const = 0;
53 * Update the scrollbar.
54 * @param height the total document height in pixels
55 * @param pos the current position in the document, in pixels
56 * @param line_height the line-scroll amount, in pixels
58 virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
60 // FIXME: this is an odd place to have it, but xforms needs it here ...
61 /// a selection exists
62 virtual void haveSelection(bool) const = 0;
63 /// get the X clipboard contents
64 virtual string const getClipboard() const = 0;
65 /// fill the clipboard
66 virtual void putClipboard(string const &) const = 0;
68 /// work area dimensions have changed
69 boost::signal0<void> workAreaResize;
70 /// the scrollbar has changed
71 boost::signal1<void, int> scrollDocView;
72 /// a key combination has been pressed
73 boost::signal2<void, LyXKeySymPtr, key_modifier::state> workAreaKeyPress;
74 /// a mouse button has been pressed
75 boost::signal3<void, int, int, mouse_button::state> workAreaButtonPress;
76 /// a mouse button has been released
77 boost::signal3<void, int, int, mouse_button::state> workAreaButtonRelease;
78 /// the mouse has moved
79 boost::signal3<void, int, int, mouse_button::state> workAreaMotionNotify;
80 /// a mouse button has been double-clicked
81 boost::signal3<void, int, int, mouse_button::state> workAreaDoubleClick;
82 /// a mouse button has been triple-clicked
83 boost::signal3<void, int, int, mouse_button::state> workAreaTripleClick;
84 /// emitted when an X client has requested our selection
85 boost::signal0<void> selectionRequested;
86 /// emitted when another X client has stolen our selection
87 boost::signal0<void> selectionLost;