← Back to branch summary

~ubuntu-branches/debian/sid/ncurses/sid

« back to all changes in this revision

Viewing changes to man/curs_outopts.3x

  • Committer: Package Import Robot
  • Author(s): Sven Joachim
  • Date: 2015-08-17 18:01:53 UTC
  • mfrom: (1.32.11)
  • Revision ID: package-import@ubuntu.com-20150817180153-ywf02awpkuzvqwdv
Tags: 6.0+20150810-1
http://bugs.debian.org/790548
http://bugs.debian.org/788610
* New upstream release.
  - Fix comparison against "/usr/include" in misc/gen-pkgconfig.in
    (Closes: #790548).
* Configure with "--with-abi-version=5", upstream defaults to abi 6 now.
* Configure with "--with-versioned-syms" (Closes: #788610).
  - Bump minimal versions of all symbols as well as shlibs to 6.
* After building the wide library, install it into a temporary
  scratchdir so that test/configure can find the necessary auxiliary
  files (see #786436).
* Drop the libncursesw5-dev build-dependency.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/curs_outopts.3x
1
1
.\"***************************************************************************
2
 
.\" Copyright (c) 1998-2007,2010 Free Software Foundation, Inc.              *
 
2
.\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
3
3
.\"                                                                          *
4
4
.\" Permission is hereby granted, free of charge, to any person obtaining a  *
5
5
.\" copy of this software and associated documentation files (the            *
26
26
.\" authorization.                                                           *
27
27
.\"***************************************************************************
28
28
.\"
29
 
.\" $Id: curs_outopts.3x,v 1.25 2010/12/04 18:38:55 tom Exp $
 
29
.\" $Id: curs_outopts.3x,v 1.26 2015/07/21 00:23:43 tom Exp $
30
30
.TH curs_outopts 3X ""
31
31
.na
32
32
.hy 0
46
46
.SH SYNOPSIS
47
47
\fB#include <curses.h>\fR
48
48
.sp
49
 
\fBint clearok(WINDOW *win, bool bf);\fR
50
 
.br
51
 
\fBint idlok(WINDOW *win, bool bf);\fR
52
 
.br
53
 
\fBvoid idcok(WINDOW *win, bool bf);\fR
54
 
.br
55
 
\fBvoid immedok(WINDOW *win, bool bf);\fR
56
 
.br
57
 
\fBint leaveok(WINDOW *win, bool bf);\fR
58
 
.br
59
 
\fBint setscrreg(int top, int bot);\fR
60
 
.br
61
 
\fBint wsetscrreg(WINDOW *win, int top, int bot);\fR
62
 
.br
63
 
\fBint scrollok(WINDOW *win, bool bf);\fR
 
49
\fBint clearok(WINDOW *\fP\fIwin\fP\fB, bool \fP\fIbf\fP\fB);\fR
 
50
.br
 
51
\fBint idlok(WINDOW *\fP\fIwin\fP\fB, bool \fP\fIbf\fP\fB);\fR
 
52
.br
 
53
\fBvoid idcok(WINDOW *\fP\fIwin\fP\fB, bool \fP\fIbf\fP\fB);\fR
 
54
.br
 
55
\fBvoid immedok(WINDOW *\fP\fIwin\fP\fB, bool \fP\fIbf\fP\fB);\fR
 
56
.br
 
57
\fBint leaveok(WINDOW *\fP\fIwin\fP\fB, bool \fP\fIbf\fP\fB);\fR
 
58
.br
 
59
\fBint setscrreg(int \fP\fItop\fP\fB, int \fP\fIbot\fP\fB);\fR
 
60
.br
 
61
\fBint wsetscrreg(WINDOW *\fP\fIwin\fP\fB, int \fP\fItop\fP\fB, int \fP\fIbot\fP\fB);\fR
 
62
.br
 
63
\fBint scrollok(WINDOW *\fP\fIwin\fP\fB, bool \fP\fIbf\fP\fB);\fR
64
64
.br
65
65
\fBint nl(void);\fR
66
66
.br
71
71
\fBcurses\fR.
72
72
All options are initially \fBFALSE\fR, unless otherwise stated.
73
73
It is not necessary to turn these options off before calling \fBendwin\fR.
 
74
.SS clearok
74
75
.PP
75
76
If \fBclearok\fR is called with \fBTRUE\fR as argument, the next
76
77
call to \fBwrefresh\fR with this window will clear the screen completely and
81
82
the \fIwin\fR argument to \fBclearok\fR is the global variable \fBcurscr\fR,
82
83
the next call to \fBwrefresh\fR with any window causes the screen to be cleared
83
84
and repainted from scratch.
 
85
.SS idlok
84
86
.PP
85
87
If \fBidlok\fR is called with \fBTRUE\fR as second argument, \fBcurses\fR
86
88
considers using the hardware insert/delete line feature of terminals so
94
96
when used in applications where it is not really needed.
95
97
If insert/delete line
96
98
cannot be used, \fBcurses\fR redraws the changed portions of all lines.
 
99
.SS idcok
97
100
.PP
98
101
If \fBidcok\fR is called with \fBFALSE\fR as second argument, \fBcurses\fR
99
102
no longer considers using the hardware insert/delete character feature of
101
104
Use of character insert/delete is enabled by default.
102
105
Calling \fBidcok\fR with \fBTRUE\fR as second argument re-enables use
103
106
of character insertion and deletion.
 
107
.SS immedok
104
108
.PP
105
109
If \fBimmedok\fR is called with \fBTRUE as argument\fR, any change
106
110
in the window image, such as the ones caused by \fBwaddch, wclrtobot, wscrl\fR,
108
112
However, it may
109
113
degrade performance considerably, due to repeated calls to \fBwrefresh\fR.
110
114
It is disabled by default.
 
115
.SS leaveok
111
116
.PP
112
117
Normally, the hardware cursor is left at the location of the window cursor
113
118
being refreshed.
115
120
wherever the update happens to leave it.
116
121
It is useful for applications where
117
122
the cursor is not used, since it reduces the need for cursor motions.
 
123
.SS setscrreg
118
124
.PP
119
125
The \fBsetscrreg\fR and \fBwsetscrreg\fR routines allow the application
120
126
programmer to set a software scrolling region in a window.
133
139
If \fBidlok\fR is enabled and the terminal
134
140
has either a scrolling region or insert/delete line capability, they will
135
141
probably be used by the output routines.)
 
142
.SS scrollok
136
143
.PP
137
144
The \fBscrollok\fR option controls what happens when the cursor of a window is
138
145
moved off the edge of the window or scrolling region, either as a result of a
143
150
If enabled, (\fIbf\fR is \fBTRUE\fR), the window is scrolled up one line
144
151
(Note that to get the physical scrolling effect on the terminal, it is
145
152
also necessary to call \fBidlok\fR).
 
153
.SS nl, nonl
146
154
.PP
147
155
The \fBnl\fR and \fBnonl\fR routines control whether the underlying display
148
156
device translates the return key into newline on input, and whether it
161
169
All other routines that return an integer always
162
170
return \fBOK\fR.
163
171
.PP
164
 
X/Open does not define any error conditions.
 
172
X/Open Curses does not define any error conditions.
165
173
.PP
166
174
In this implementation, those functions that have a window pointer
167
175
will return an error if the window pointer is null.
213
221
The \fBimmedok\fR routine is useful for windows that are used as terminal
214
222
emulators.
215
223
.SH SEE ALSO
 
224
.na
216
225
\fBcurses\fR(3X),
217
226
\fBcurs_addch\fR(3X),
218
227
\fBcurs_clear\fR(3X),