is_wintouched(3xcurses)

1is_linetouched(3XCURSES)X/Open Curses Library Functionsis_linetouched(3XCURSES)
2
3
4

NAME

6       is_linetouched,   is_wintouched,   touchline,   touchwin,   untouchwin,
7       wtouchln - control window refresh
8

SYNOPSIS

10       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
11        -R  /usr/xpg4/lib  -lcurses  [ library... ]
12
13       c89 [ flag... ] file... -lcurses [ library... ]
14
15       #include <curses.h>
16
17       bool is_linetouched(WINDOW *win, int line);
18
19
20       bool is_wintouched(WINDOW *win);
21
22
23       int touchline(WINDOW *win, int start, int count);
24
25
26       int touchwin(WINDOW *win);
27
28
29       int untouchwin(WINDOW *win);
30
31
32       int wtouchln(WINDOW *win, int y, int n, int changed);
33
34

PARAMETERS

36       win        Is a pointer to the window in which the  refresh  is  to  be
37                  controlled or monitored.
38
39
40       line       Is the line to be checked for change since refresh.
41
42
43       start      Is  the starting line number of the portion of the window to
44                  make appear changed.
45
46
47       count      Is the number of lines in the window to mark as changed.
48
49
50       y          Is the starting line number of the portion of the window  to
51                  make appear changed or not changed.
52
53
54       n          Is the number of lines in the window to mark as changed.
55
56
57       changed    Is  a flag indicating whether to make lines look changed (0)
58                  or not changed (1).
59
60

DESCRIPTION

62       The touchwin() function marks the entire window as dirty. This makes it
63       appear  to  X/Open Curses as if the whole window has been changed, thus
64       causing the entire window  to  be  rewritten  with  the  next  call  to
65       refresh(3XCURSES).  This  is sometimes necessary when using overlapping
66       windows; the change to one window will not be reflected  in  the  other
67       and, hence will not be recorded.
68
69
70       The  touchline() function marks as dirty a portion of the window start‐
71       ing at line start and continuing for count lines instead of the  entire
72       window.  Consequently,  that  portion of the window is updated with the
73       next call to refresh().
74
75
76       The untouchwin() function marks all lines in the  window  as  unchanged
77       since the last refresh, ensuring that it is not updated.
78
79
80       The  wtouchln()  function  marks  n  lines starting at line y as either
81       changed (changed=1) or unchanged (changed=0) since the last refresh.
82
83
84       To find out which lines or windows have been  changed  since  the  last
85       refresh,   use  the  is_linetouched()  and  is_wintouched()  functions,
86       respectively. These return TRUE if the specified line  or  window  have
87       been  changed  since  the last call to refresh() or FALSE if no changes
88       have been made.
89

RETURN VALUES

91       On success, these functions return OK. Otherwise, they return ERR.
92

ERRORS

94       None.
95

ATTRIBUTES

97       See attributes(5) for descriptions of the following attributes:
98
99
100
101
102       ┌─────────────────────────────┬─────────────────────────────┐
103       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
104       ├─────────────────────────────┼─────────────────────────────┤
105       │Interface Stability          │Standard                     │
106       ├─────────────────────────────┼─────────────────────────────┤
107       │MT-Level                     │Unsafe                       │
108       └─────────────────────────────┴─────────────────────────────┘
109