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"
44 /// types of cursor in work area
48 /// L-shape for locked insets of a different language
50 /// reverse L-shape for RTL text
56 * The work area class represents the widget that provides the
57 * view onto a document. It is owned by the BufferView, and
58 * is responsible for handing events back to its owning BufferView.
59 * It works in concert with the BaseScreen class to update the
60 * widget view of a document.
64 WorkArea(BufferView * buffer_view = 0);
66 virtual ~WorkArea() {}
68 void setBufferView(BufferView * buffer_view);
71 BufferView & bufferView();
73 BufferView const & bufferView() const;
75 /// return the painter object for this work area
76 virtual Painter & getPainter() = 0;
78 /// return the width of the work area in pixels
79 virtual int width() const = 0;
81 /// return the height of the work area in pixels
82 virtual int height() const = 0;
85 * Update the scrollbar.
86 * @param height the total document height in pixels
87 * @param pos the current position in the document, in pixels
88 * @param line_height the line-scroll amount, in pixels
90 virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
92 /// redraw the screen, without using existing pixmap
93 virtual void redraw();
96 void processKeySym(LyXKeySymPtr key, key_modifier::state state);
98 /// grey out (no buffer)
101 /// paint the cursor and store the background
102 virtual void showCursor(int x, int y, int h, CursorShape shape) = 0;
105 virtual void removeCursor() = 0;
111 /// toggle the cursor's visibility
115 /// cause the display of the given area of the work area
116 virtual void expose(int x, int y, int w, int h) = 0;
119 BufferView * buffer_view_;
123 void checkAndGreyOut();
129 bool cursor_visible_;
132 Timeout cursor_timeout_;
135 } // namespace frontend
138 #endif // BASE_WORKAREA_H