1TICKIT_WINDOW_SCROLL(3) Library Functions Manual TICKIT_WINDOW_SCROLL(3)
2
6 tickit_window_scroll, tickit_window_scrollrect - scroll the area of a
7 window
8
10 #include <tickit.h>
11 bool tickit_window_scroll(TickitWindow *win, int downward, int rightward);
13 bool tickit_window_scrollrect(TickitWindow *win, const TickitRect *rect,
14 int downward, int rightward, TickitPen *pen);
15 bool tickit_window_scroll_with_children(TickitWindow *win,
17 int downward, int rightward);
18 Link with -ltickit.
20
22 tickit_window_scroll() requests that the underlying terminal scroll the
23 contents of the area corresponding to the visible region (or regions)
24 of the given window by the given amount. This takes into account as‐
25 pects of the visibility of the window, such as being obscured by sib‐
26 lings or siblings of ancestors, child windows, or whether the window or
27 any parent is hidden. It returns true if it managed to perform the re‐
28 quired scrolling, or false if not.
29 tickit_window_scrollrect() requests that the terminal scroll the con‐
31 tents of the area corresponding to the given rectangle within the win‐
32 dow, and otherwise works analogously to tickit_window_scroll(). If the
33 pen argument is non-NULL then it is applied to the terminal before any
34 erase operations within the window are performed, allowing a different
35 background colour if set.
36 tickit_window_scroll_with_children() is similar again, except that it
38 does not consider obscuring regions by child windows; only siblings or
39 siblings of ancestors. This is intended for scrolling a container of
40 windows, which will move all of the sub-windows too. Note that this
41 function does not actually move the child windows, it simply requests a
42 scrolling operation on the underlying terminal.
43
45 These functions all return a boolean.
46
48 tickit_window_new(3), tickit_window_set_geometry(3), tickit_window_ex‐
49 pose(3), tickit_window(7), tickit(7)
50 TICKIT_WINDOW_SCROLL(3)