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"
47 /// types of cursor in work area
51 /// L-shape for locked insets of a different language
53 /// reverse L-shape for RTL text
58 * The work area class represents the widget that provides the
59 * view onto a document. It is owned by the BufferView, and
60 * is responsible for handing events back to its owning BufferView.
61 * It works in concert with the BaseScreen class to update the
62 * widget view of a document.
66 WorkArea(LyXView & lyx_view);
68 virtual ~WorkArea() {}
70 void setBufferView(BufferView * buffer_view);
73 BufferView & bufferView();
75 BufferView const & bufferView() const;
78 /// return the painter object for this work area
79 virtual Painter & getPainter() = 0;
81 /// return the width of the work area in pixels
82 virtual int width() const = 0;
84 /// return the height of the work area in pixels
85 virtual int height() const = 0;
88 * Update the scrollbar.
89 * @param height the total document height in pixels
90 * @param pos the current position in the document, in pixels
91 * @param line_height the line-scroll amount, in pixels
93 virtual void setScrollbarParams(int height, int pos, int line_height) = 0;
95 /// redraw the screen, without using existing pixmap
96 virtual void redraw();
98 /// grey out (no buffer)
101 /// FIXME: should be protected, public until the qt3 and gtk frontends are
103 void processKeySym(LyXKeySymPtr key, key_modifier::state state);
106 /// cause the display of the given area of the work area
107 virtual void expose(int x, int y, int w, int h) = 0;
110 /// FIXME: This is public because of qt3 and gtk, should be protected
111 void dispatch(FuncRequest const & cmd0);
113 /// FIXME: This is public because of qt3 and gtk, should be protected
114 void resizeBufferView();
116 /// FIXME: This is public because of qt3 and gtk, should be protected
117 void scrollBufferView(int position);
120 /// hide the visible cursor, if it is visible
123 /// show the cursor if it is not visible
126 /// toggle the cursor's visibility
130 virtual void removeCursor() = 0;
132 /// paint the cursor and store the background
133 virtual void showCursor(int x, int y, int h, CursorShape shape) = 0;
136 BufferView * buffer_view_;
143 void checkAndGreyOut();
148 /// is the cursor currently displayed
149 bool cursor_visible_;
152 Timeout cursor_timeout_;
155 } // namespace frontend
158 #endif // BASE_WORKAREA_H