1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169
170
171
172
173
174
175
176
177
178
179
180
181
182
183
184
185
186
187
188
189
190
191
192
193
194
195
196
197
198
199
200
201
202
203
204
205
206
207
208
209
210
211
212
213
214
215
216
217
218
219
220
221
222
223
224
225
226
227
228
229
230
231
232
233
234
235
236
237
238
239
240
241
242
243
244
245
246
247
248
249
250
251
252
253
254
255
256
257
258
259
260
261
262
|
/* PDCurses */
#include "curspriv.h"
/*man-start**************************************************************
outopts
-------
### Synopsis
int clearok(WINDOW *win, bool bf);
int idlok(WINDOW *win, bool bf);
void idcok(WINDOW *win, bool bf);
void immedok(WINDOW *win, bool bf);
int leaveok(WINDOW *win, bool bf);
int setscrreg(int top, int bot);
int wsetscrreg(WINDOW *win, int top, int bot);
int wgetscrreg(const WINDOW *win, int *top, int *bot);
int scrollok(WINDOW *win, bool bf);
int raw_output(bool bf);
bool is_cleared(const WINDOW *win);
bool is_idlok(const WINDOW *win);
bool is_idcok(const WINDOW *win);
bool is_immedok(const WINDOW *win);
bool is_leaveok(const WINDOW *win);
bool is_scrollok(const WINDOW *win);
### Description
With clearok(), if bf is TRUE, the next call to wrefresh() with this
window will clear the screen completely and redraw the entire screen.
immedok(), called with a second argument of TRUE, causes an automatic
wrefresh() every time a change is made to the specified window.
Normally, the hardware cursor is left at the location of the window
being refreshed. leaveok() allows the cursor to be left wherever the
update happens to leave it. It's useful for applications where the
cursor is not used, since it reduces the need for cursor motions. If
possible, the cursor is made invisible when this option is enabled.
wsetscrreg() sets a scrolling region in a window; "top" and "bot" are
the line numbers for the top and bottom margins. If this option and
scrollok() are enabled, any attempt to move off the bottom margin
will cause all lines in the scrolling region to scroll up one line.
setscrreg() is the stdscr version.
wgetscrreg() gets the top and bottom margins as set in wsetscrreg().
idlok() and idcok() do nothing in PDCurses, but are provided for
compatibility with other curses implementations, likewise is_idlok()
and is_idcok().
raw_output() enables the output of raw characters using the standard
*add* and *ins* curses functions (that is, it disables translation of
control characters).
is_cleared() reports whether the specified window causes clear at next
refresh.
is_immedok() reports whether the specified window is in immedok mode.
is_leaveok() reports whether the specified window is in leaveok mode.
is_scrollok() reports whether the specified window allows scrolling.
### Return Value
is_cleared(), is_immedok(), is_leaveok() and is_scrollok() return TRUE
or FALSE. is_idlok() and is_idcok() are provided for compatibility with
other curses implementations, and always return FALSE. All others
return OK on success and ERR on error.
### Portability
Function | X/Open | ncurses | NetBSD
:---------------------|:------:|:-------:|:------:
clearok | Y | Y | Y
idlok | Y | Y | Y
idcok | Y | Y | Y
immedok | Y | Y | Y
leaveok | Y | Y | Y
setscrreg | Y | Y | Y
wsetscrreg | Y | Y | Y
wgetscrreg | - | Y | -
scrollok | Y | Y | Y
is_cleared | - | Y | -
is_idlok | - | Y | -
is_idcok | - | Y | -
is_immedok | - | Y | -
is_leaveok | - | Y | Y
is_scrollok | - | Y | -
raw_output | - | - | -
**man-end****************************************************************/
int clearok(WINDOW *win, bool bf)
{
PDC_LOG(("clearok() - called\n"));
if (!win)
return ERR;
win->_clear = bf;
return OK;
}
int idlok(WINDOW *win, bool bf)
{
PDC_LOG(("idlok() - called\n"));
return OK;
}
void idcok(WINDOW *win, bool bf)
{
PDC_LOG(("idcok() - called\n"));
}
void immedok(WINDOW *win, bool bf)
{
PDC_LOG(("immedok() - called\n"));
if (win)
win->_immed = bf;
}
int leaveok(WINDOW *win, bool bf)
{
PDC_LOG(("leaveok() - called\n"));
if (!win)
return ERR;
win->_leaveit = bf;
curs_set(!bf);
return OK;
}
int setscrreg(int top, int bottom)
{
PDC_LOG(("setscrreg() - called: top %d bottom %d\n", top, bottom));
return wsetscrreg(stdscr, top, bottom);
}
int wsetscrreg(WINDOW *win, int top, int bottom)
{
PDC_LOG(("wsetscrreg() - called: top %d bottom %d\n", top, bottom));
if (win && 0 <= top && top <= win->_cury &&
win->_cury <= bottom && bottom < win->_maxy)
{
win->_tmarg = top;
win->_bmarg = bottom;
return OK;
}
else
return ERR;
}
int wgetscrreg(const WINDOW *win, int *top, int *bot)
{
PDC_LOG(("wgetscrreg() - called\n"));
if (!win || !top || !bot)
return ERR;
*top = win->_tmarg;
*bot = win->_bmarg;
return OK;
}
int scrollok(WINDOW *win, bool bf)
{
PDC_LOG(("scrollok() - called\n"));
if (!win)
return ERR;
win->_scroll = bf;
return OK;
}
int raw_output(bool bf)
{
PDC_LOG(("raw_output() - called\n"));
if (!SP)
return ERR;
SP->raw_out = bf;
return OK;
}
bool is_cleared(const WINDOW *win)
{
PDC_LOG(("is_cleared() - called\n"));
if (!win)
return FALSE;
return win->_clear;
}
bool is_idlok(const WINDOW *win)
{
(void) win;
PDC_LOG(("is_idlok() - called\n"));
return FALSE;
}
bool is_idcok(const WINDOW *win)
{
(void) win;
PDC_LOG(("is_idcok() - called\n"));
return FALSE;
}
bool is_immedok(const WINDOW *win)
{
PDC_LOG(("is_immedok() - called\n"));
if (!win)
return FALSE;
return win->_immed;
}
bool is_leaveok(const WINDOW *win)
{
PDC_LOG(("is_leaveok() - called\n"));
if (!win)
return FALSE;
return win->_leaveit;
}
bool is_scrollok(const WINDOW *win)
{
PDC_LOG(("is_scrollok() - called\n"));
if (!win)
return FALSE;
return win->_scroll;
}
|
