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"
46 /// types of cursor in work area
50 /// L-shape for locked insets of a different language
52 /// reverse L-shape for RTL text
57 * The work area class represents the widget that provides the
58 * view onto a document. It is owned by the BufferView, and
59 * is responsible for handing events back to its owning BufferView.
60 * It works in concert with the BaseScreen class to update the
61 * widget view of a document.
65 WorkArea(BufferView * buffer_view = 0);
67 virtual ~WorkArea() {}
69 void setBufferView(BufferView * buffer_view);
72 BufferView & bufferView();
74 BufferView const & bufferView() const;
77 /// return the painter object for this work area
78 virtual Painter & getPainter() = 0;
80 /// return the width of the work area in pixels
81 virtual int width() const = 0;
83 /// return the height of the work area in pixels
84 virtual int height() const = 0;
87 * Update the scrollbar.
88 * @param height the total document height in pixels
89 * @param pos the current position in the document, in pixels
90 * @param line_height the line-scroll amount, in pixels
92 virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
94 /// redraw the screen, without using existing pixmap
95 virtual void redraw();
97 /// grey out (no buffer)
100 /// FIXME: should be protected, public until the qt3 and gtk frontends are
102 void processKeySym(LyXKeySymPtr key, key_modifier::state state);
105 /// cause the display of the given area of the work area
106 virtual void expose(int x, int y, int w, int h) = 0;
109 /// FIXME: This is public because of qt3 and gtk, should be protected
110 void dispatch(FuncRequest const & cmd0);
114 void resizeBufferView();
117 /// hide the visible cursor, if it is visible
120 /// show the cursor if it is not visible
123 /// toggle the cursor's visibility
127 virtual void removeCursor() = 0;
129 /// paint the cursor and store the background
130 virtual void showCursor(int x, int y, int h, CursorShape shape) = 0;
133 BufferView * buffer_view_;
137 void checkAndGreyOut();
142 /// is the cursor currently displayed
143 bool cursor_visible_;
146 Timeout cursor_timeout_;
149 } // namespace frontend
152 #endif // BASE_WORKAREA_H