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>
34 /// types of cursor in work area
38 /// L-shape for locked insets of a different language
40 /// reverse L-shape for RTL text
45 * The work area class represents the widget that provides the
46 * view onto a document. It is owned by the BufferView, and
47 * is responsible for handing events back to its owning BufferView.
48 * It works in concert with the BaseScreen class to update the
49 * widget view of a document.
51 class WorkArea : public boost::signals::trackable {
53 WorkArea(LyXView & lyx_view);
55 virtual ~WorkArea() {}
57 void setBufferView(BufferView * buffer_view);
60 BufferView & bufferView();
62 BufferView const & bufferView() const;
65 /// return the painter object for this work area
66 virtual Painter & getPainter() = 0;
68 /// return the width of the work area in pixels
69 virtual int width() const = 0;
71 /// return the height of the work area in pixels
72 virtual int height() const = 0;
75 * Update the scrollbar.
76 * @param height the total document height in pixels
77 * @param pos the current position in the document, in pixels
78 * @param line_height the line-scroll amount, in pixels
80 virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
82 /// redraw the screen, without using existing pixmap
83 virtual void redraw();
85 /// grey out (no buffer)
88 /// FIXME: should be protected, public until the qt3 and gtk frontends are
90 void processKeySym(LyXKeySymPtr key, key_modifier::state state);
93 /// cause the display of the given area of the work area
94 virtual void expose(int x, int y, int w, int h) = 0;
97 /// FIXME: This is public because of qt3 and gtk, should be protected
98 void dispatch(FuncRequest const & cmd0);
100 /// FIXME: This is public because of qt3 and gtk, should be protected
101 void resizeBufferView();
103 /// FIXME: This is public because of qt3 and gtk, should be protected
104 void scrollBufferView(int position);
107 /// hide the visible cursor, if it is visible
110 /// show the cursor if it is not visible
113 /// toggle the cursor's visibility
117 virtual void removeCursor() = 0;
119 /// paint the cursor and store the background
120 virtual void showCursor(int x, int y, int h, CursorShape shape) = 0;
123 BufferView * buffer_view_;
130 void updateScrollbar();
132 void checkAndGreyOut();
134 void displayMessage(lyx::docstring const &);
135 /// buffer messages signal connection
136 boost::signals::connection message_connection_;
141 /// is the cursor currently displayed
142 bool cursor_visible_;
145 Timeout cursor_timeout_;
148 } // namespace frontend
151 #endif // BASE_WORKAREA_H