4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
9 * \author Abdelrazak Younes
11 * Full author contact details are available in file CREDITS.
14 #ifndef BASE_WORKAREA_H
15 #define BASE_WORKAREA_H
17 #include "frontends/key_state.h"
18 #include "frontends/LyXKeySym.h"
19 #include "frontends/Timeout.h"
21 #include "support/docstring.h"
23 #include <boost/signals/trackable.hpp>
25 // FIXME: defined in X.h, spuriously pulled in by Qt 3 headers
38 /// types of cursor in work area
42 /// L-shape for locked insets of a different language
44 /// reverse L-shape for RTL text
49 * The work area class represents the widget that provides the
50 * view onto a document. It is owned by the BufferView, and
51 * is responsible for handing events back to its owning BufferView.
52 * It works in concert with the BaseScreen class to update the
53 * widget view of a document.
55 class WorkArea : public boost::signals::trackable {
57 WorkArea(LyXView & lyx_view);
59 virtual ~WorkArea() {}
61 void setBufferView(BufferView * buffer_view);
64 BufferView & bufferView();
66 BufferView const & bufferView() const;
69 /// return the painter object for this work area
70 virtual Painter & getPainter() = 0;
72 /// return the width of the work area in pixels
73 virtual int width() const = 0;
75 /// return the height of the work area in pixels
76 virtual int height() const = 0;
79 * Update the scrollbar.
80 * @param height the total document height in pixels
81 * @param pos the current position in the document, in pixels
82 * @param line_height the line-scroll amount, in pixels
84 virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
86 /// redraw the screen, without using existing pixmap
87 virtual void redraw();
89 /// grey out (no buffer)
92 /// FIXME: should be protected, public until the gtk frontend are
94 void processKeySym(LyXKeySymPtr key, key_modifier::state state);
97 /// cause the display of the given area of the work area
98 virtual void expose(int x, int y, int w, int h) = 0;
101 /// FIXME: This is public because of gtk, should be protected
102 void dispatch(FuncRequest const & cmd0);
104 /// FIXME: This is public because of gtk, should be protected
105 void resizeBufferView();
107 /// FIXME: This is public because of gtk, should be protected
108 void scrollBufferView(int position);
111 /// hide the visible cursor, if it is visible
114 /// show the cursor if it is not visible
117 /// toggle the cursor's visibility
121 virtual void removeCursor() = 0;
123 /// paint the cursor and store the background
124 virtual void showCursor(int x, int y, int h, CursorShape shape) = 0;
127 BufferView * buffer_view_;
134 void updateScrollbar();
136 void checkAndGreyOut();
138 void displayMessage(docstring const &);
139 /// buffer messages signal connection
140 boost::signals::connection message_connection_;
145 /// is the cursor currently displayed
146 bool cursor_visible_;
149 Timeout cursor_timeout_;
152 } // namespace frontend
155 #endif // BASE_WORKAREA_H