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
24 * LyXScreen - document rendering management
26 * This class is used to manage the on-screen rendering inside the
27 * work area; it is responsible for deciding which LyXText rows
30 * This class will arrange for LyXText to paint onto a pixmap
31 * provided by the WorkArea widget.
33 * The blinking cursor is also handled here.
42 * fit the cursor onto the visible work area, scrolling if necessary
43 * @param bv the buffer view
44 * @param vheight the height of the visible region
45 * @param base_y the top of the lyxtext to look at
46 * @param x the new x position
47 * @param y the new y position
48 * @param a ascent of the cursor's row
49 * @param d descent of the cursor's row
50 * @return true if the work area needs scrolling as a result
52 bool fitManualCursor(BufferView * bv, LyXText * text,
53 int x, int y, int a, int d);
55 /// redraw the screen, without using existing pixmap
56 virtual void redraw(BufferView & bv);
59 * topCursorVisible - get a new "top" to make the cursor visible
62 * This helper function calculates a new y co-ordinate for
63 * the top of the containing region such that the cursor contained
64 * within the LyXText is "nicely" visible.
66 virtual unsigned int topCursorVisible(LyXText *);
69 * fitCursor - fit the cursor onto the work area
70 * @param text the text containing the cursor
71 * @param bv the bufferview
72 * @return true if a change was necessary
74 * Scrolls the screen so that the cursor is visible
76 virtual bool fitCursor(LyXText *, BufferView *);
78 /// hide the visible cursor, if it is visible
81 /// show the cursor if it is not visible
82 void showCursor(BufferView & bv);
84 /// toggle the cursor's visibility
85 void toggleCursor(BufferView & bv);
88 /// cause the display of the given area of the work area
89 virtual void expose(int x, int y, int w, int h) = 0;
92 virtual WorkArea & workarea() const = 0;
94 /// types of cursor in work area
98 /// L-shape for locked insets of a different language
100 /// reverse L-shape for RTL text
104 /// paint the cursor and store the background
105 virtual void showCursor(int x, int y, int h, Cursor_Shape shape) = 0;
108 virtual void removeCursor() = 0;
111 /// y1 and y2 are coordinates of the screen
112 void drawFromTo(LyXText *, BufferView *);
114 /// grey out (no buffer)
117 /// is the cursor currently displayed
118 bool cursor_visible_;
120 /// is the screen displaying text or the splash screen?