4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
10 * Full author contact details are available in file CREDITS.
16 #include "frontends/key_state.h"
17 #include "frontends/LyXKeySym.h"
19 #include <boost/signal.hpp>
26 * The work area class represents the widget that provides the
27 * view onto a document. It is owned by the BufferView, and
28 * is responsible for handing events back to its owning BufferView.
29 * It works in concert with the LyXScreen class to update the
30 * widget view of a document.
36 virtual ~WorkArea() {}
38 /// return the painter object for this work area
39 virtual Painter & getPainter() = 0;
41 /// return the width of the work area in pixels
42 virtual int workWidth() const = 0;
43 /// return the height of the work area in pixels
44 virtual int workHeight() const = 0;
47 * Update the scrollbar.
48 * @param height the total document height in pixels
49 * @param pos the current position in the document, in pixels
50 * @param line_height the line-scroll amount, in pixels
52 virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
54 // FIXME: this is an odd place to have it, but xforms needs it here ...
55 /// a selection exists
56 virtual void haveSelection(bool) const = 0;
57 /// get the X clipboard contents
58 virtual std::string const getClipboard() const = 0;
59 /// fill the clipboard
60 virtual void putClipboard(std::string const &) const = 0;
62 /// work area dimensions have changed
63 boost::signal<void()> workAreaResize;
64 /// the scrollbar has changed
65 boost::signal<void(int)> scrollDocView;
66 /// a key combination has been pressed
67 boost::signal<void(LyXKeySymPtr, key_modifier::state)> workAreaKeyPress;
69 boost::signal<void(FuncRequest)> dispatch;
70 /// emitted when an X client has requested our selection
71 boost::signal<void()> selectionRequested;
72 /// emitted when another X client has stolen our selection
73 boost::signal<void()> selectionLost;