4 * This file is part of LyX, the document processor.
5 * Licence details can be found in the file COPYING.
10 * Full author contact details are available in file CREDITS.
22 * LyXScreen - document rendering management
24 * This class is used to manage the on-screen rendering inside the
25 * work area; it is responsible for deciding which LyXText rows
28 * This class will arrange for LyXText to paint onto a pixmap
29 * provided by the WorkArea widget.
31 * The blinking cursor is also handled here.
40 * fit the cursor onto the visible work area, scrolling if necessary
41 * @param bv the buffer view
42 * @param vheight the height of the visible region
43 * @param base_y the top of the lyxtext to look at
44 * @param x the new x position
45 * @param y the new y position
46 * @param a ascent of the cursor's row
47 * @param d descent of the cursor's row
48 * @return true if the work area needs scrolling as a result
50 bool fitManualCursor(BufferView * bv, LyXText * text,
51 int x, int y, int a, int d);
53 /// redraw the screen, without using existing pixmap
54 virtual void redraw(BufferView & bv);
57 * topCursorVisible - get a new "top" to make the cursor visible
60 * This helper function calculates a new y co-ordinate for
61 * the top of the containing region such that the cursor contained
62 * within the LyXText is "nicely" visible.
64 virtual unsigned int topCursorVisible(LyXText *);
67 * fitCursor - fit the cursor onto the work area
68 * @param text the text containing the cursor
69 * @param bv the bufferview
70 * @return true if a change was necessary
72 * Scrolls the screen so that the cursor is visible
74 virtual bool fitCursor(LyXText *, BufferView *);
76 /// hide the visible cursor, if it is visible
79 /// show the cursor if it is not visible
80 void showCursor(BufferView & bv);
82 /// toggle the cursor's visibility
83 void toggleCursor(BufferView & bv);
86 /// cause the display of the given area of the work area
87 virtual void expose(int x, int y, int w, int h) = 0;
90 virtual WorkArea & workarea() const = 0;
92 /// types of cursor in work area
96 /// L-shape for locked insets of a different language
98 /// reverse L-shape for RTL text
102 /// paint the cursor and store the background
103 virtual void showCursor(int x, int y, int h, Cursor_Shape shape) = 0;
106 virtual void removeCursor() = 0;
109 /// grey out (no buffer)
112 /// is the cursor currently displayed
113 bool cursor_visible_;
115 /// is the screen displaying text or the splash screen?