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 // X11 use a define called CursorShape, and we really want to use
15 // that name our selves. Therefore we do something similar to what is done
19 #ifndef FIXX11H_CursorShape
20 #define FIXX11H_CursorShape
21 int const XCursorShape = CursorShape;
23 int const CursorShape = CursorShape;
30 #ifndef BASE_WORKAREA_H
31 #define BASE_WORKAREA_H
33 #include "frontends/key_state.h"
34 #include "frontends/LyXKeySym.h"
35 #include "frontends/Timeout.h"
37 #include "support/docstring.h"
39 #include <boost/signals/trackable.hpp>
50 /// types of cursor in work area
54 /// L-shape for locked insets of a different language
56 /// reverse L-shape for RTL text
61 * The work area class represents the widget that provides the
62 * view onto a document. It is owned by the BufferView, and
63 * is responsible for handing events back to its owning BufferView.
64 * It works in concert with the BaseScreen class to update the
65 * widget view of a document.
67 class WorkArea : public boost::signals::trackable {
69 WorkArea(LyXView & lyx_view);
71 virtual ~WorkArea() {}
73 void setBufferView(BufferView * buffer_view);
76 BufferView & bufferView();
78 BufferView const & bufferView() const;
81 /// return the painter object for this work area
82 virtual Painter & getPainter() = 0;
84 /// return the width of the work area in pixels
85 virtual int width() const = 0;
87 /// return the height of the work area in pixels
88 virtual int height() const = 0;
91 * Update the scrollbar.
92 * @param height the total document height in pixels
93 * @param pos the current position in the document, in pixels
94 * @param line_height the line-scroll amount, in pixels
96 virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
98 /// redraw the screen, without using existing pixmap
99 virtual void redraw();
101 /// grey out (no buffer)
104 /// FIXME: should be protected, public until the qt3 and gtk frontends are
106 void processKeySym(LyXKeySymPtr key, key_modifier::state state);
109 /// cause the display of the given area of the work area
110 virtual void expose(int x, int y, int w, int h) = 0;
113 /// FIXME: This is public because of qt3 and gtk, should be protected
114 void dispatch(FuncRequest const & cmd0);
116 /// FIXME: This is public because of qt3 and gtk, should be protected
117 void resizeBufferView();
119 /// FIXME: This is public because of qt3 and gtk, should be protected
120 void scrollBufferView(int position);
123 /// hide the visible cursor, if it is visible
126 /// show the cursor if it is not visible
129 /// toggle the cursor's visibility
133 virtual void removeCursor() = 0;
135 /// paint the cursor and store the background
136 virtual void showCursor(int x, int y, int h, CursorShape shape) = 0;
139 BufferView * buffer_view_;
146 void updateScrollbar();
148 void checkAndGreyOut();
150 void displayMessage(lyx::docstring const &);
151 /// buffer messages signal connection
152 boost::signals::connection message_connection_;
157 /// is the cursor currently displayed
158 bool cursor_visible_;
161 Timeout cursor_timeout_;
164 } // namespace frontend
167 #endif // BASE_WORKAREA_H