mirror/ncursesw-morphos
2
0
Fork 0
mirror of https://github.com/Aigor44/ncursesw-morphos.git synced 2024-12-21 07:39:06 +08:00
Code Issues Packages Projects Releases Wiki Activity
b5a763d403
ncursesw-morphos/man/form_field_opts.3x

125 lines
4.6 KiB
Plaintext
Raw Normal View History

ncurses 4.1
1997-05-15 12:00:00 +08:00
'\" t
ncurses 5.0
1999-10-24 12:32:42 +08:00
.\"***************************************************************************
ncurses 5.6 - patch 20070224 + change internal return codes of _nc_wgetch() to check for cases where KEY_CODE_YES should be returned, e.g., if a KEY_RESIZE was ungetch'd, and read by wget_wch(). + fix static-library build broken in 20070217 changes to remove "-ldl" (report by Miroslav Lichvar). + change makefile/scripts for cygwin to allow building termlib. + use Form_Hook in manpages to match form.h + use Menu_Hook in manpages, as well as a few places in menu.h + correct form- and menu-manpages to use specific Field_Options, Menu_Options and Item_Options types. + correct prototype for _tracechar() in manpage (cf: 20011229). + correct prototype for wunctrl() in manpage.
2007-02-25 09:57:04 +08:00
.\" Copyright (c) 1998-2006,2007 Free Software Foundation, Inc. *
ncurses 5.0
1999-10-24 12:32:42 +08:00
.\" *
.\" Permission is hereby granted, free of charge, to any person obtaining a *
.\" copy of this software and associated documentation files (the *
.\" "Software"), to deal in the Software without restriction, including *
.\" without limitation the rights to use, copy, modify, merge, publish, *
.\" distribute, distribute with modifications, sublicense, and/or sell *
.\" copies of the Software, and to permit persons to whom the Software is *
.\" furnished to do so, subject to the following conditions: *
.\" *
.\" The above copyright notice and this permission notice shall be included *
.\" in all copies or substantial portions of the Software. *
.\" *
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
.\" *
.\" Except as contained in this notice, the name(s) of the above copyright *
.\" holders shall not be used in advertising or otherwise to promote the *
.\" sale, use or other dealings in this Software without prior written *
.\" authorization. *
.\"***************************************************************************
.\"
ncurses 5.6 - patch 20070224 + change internal return codes of _nc_wgetch() to check for cases where KEY_CODE_YES should be returned, e.g., if a KEY_RESIZE was ungetch'd, and read by wget_wch(). + fix static-library build broken in 20070217 changes to remove "-ldl" (report by Miroslav Lichvar). + change makefile/scripts for cygwin to allow building termlib. + use Form_Hook in manpages to match form.h + use Menu_Hook in manpages, as well as a few places in menu.h + correct form- and menu-manpages to use specific Field_Options, Menu_Options and Item_Options types. + correct prototype for _tracechar() in manpage (cf: 20011229). + correct prototype for wunctrl() in manpage.
2007-02-25 09:57:04 +08:00
.\" $Id: form_field_opts.3x,v 1.13 2007/02/24 17:34:27 tom Exp $
ncurses 4.1
1997-05-15 12:00:00 +08:00
.TH form_field_opts 3X ""
.SH NAME
\fBform_field_opts\fR - set and get field options
.SH SYNOPSIS
\fB#include <form.h>\fR
.br
ncurses 5.6 - patch 20070224 + change internal return codes of _nc_wgetch() to check for cases where KEY_CODE_YES should be returned, e.g., if a KEY_RESIZE was ungetch'd, and read by wget_wch(). + fix static-library build broken in 20070217 changes to remove "-ldl" (report by Miroslav Lichvar). + change makefile/scripts for cygwin to allow building termlib. + use Form_Hook in manpages to match form.h + use Menu_Hook in manpages, as well as a few places in menu.h + correct form- and menu-manpages to use specific Field_Options, Menu_Options and Item_Options types. + correct prototype for _tracechar() in manpage (cf: 20011229). + correct prototype for wunctrl() in manpage.
2007-02-25 09:57:04 +08:00
int set_field_opts(FIELD *field, Field_Options opts);
ncurses 4.1
1997-05-15 12:00:00 +08:00
.br
ncurses 5.6 - patch 20070224 + change internal return codes of _nc_wgetch() to check for cases where KEY_CODE_YES should be returned, e.g., if a KEY_RESIZE was ungetch'd, and read by wget_wch(). + fix static-library build broken in 20070217 changes to remove "-ldl" (report by Miroslav Lichvar). + change makefile/scripts for cygwin to allow building termlib. + use Form_Hook in manpages to match form.h + use Menu_Hook in manpages, as well as a few places in menu.h + correct form- and menu-manpages to use specific Field_Options, Menu_Options and Item_Options types. + correct prototype for _tracechar() in manpage (cf: 20011229). + correct prototype for wunctrl() in manpage.
2007-02-25 09:57:04 +08:00
int field_opts_on(FIELD *field, Field_Options opts);
ncurses 4.1
1997-05-15 12:00:00 +08:00
.br
ncurses 5.6 - patch 20070224 + change internal return codes of _nc_wgetch() to check for cases where KEY_CODE_YES should be returned, e.g., if a KEY_RESIZE was ungetch'd, and read by wget_wch(). + fix static-library build broken in 20070217 changes to remove "-ldl" (report by Miroslav Lichvar). + change makefile/scripts for cygwin to allow building termlib. + use Form_Hook in manpages to match form.h + use Menu_Hook in manpages, as well as a few places in menu.h + correct form- and menu-manpages to use specific Field_Options, Menu_Options and Item_Options types. + correct prototype for _tracechar() in manpage (cf: 20011229). + correct prototype for wunctrl() in manpage.
2007-02-25 09:57:04 +08:00
int field_opts_off(FIELD *field, Field_Options opts);
ncurses 4.1
1997-05-15 12:00:00 +08:00
.br
ncurses 5.6 - patch 20070224 + change internal return codes of _nc_wgetch() to check for cases where KEY_CODE_YES should be returned, e.g., if a KEY_RESIZE was ungetch'd, and read by wget_wch(). + fix static-library build broken in 20070217 changes to remove "-ldl" (report by Miroslav Lichvar). + change makefile/scripts for cygwin to allow building termlib. + use Form_Hook in manpages to match form.h + use Menu_Hook in manpages, as well as a few places in menu.h + correct form- and menu-manpages to use specific Field_Options, Menu_Options and Item_Options types. + correct prototype for _tracechar() in manpage (cf: 20011229). + correct prototype for wunctrl() in manpage.
2007-02-25 09:57:04 +08:00
Field_Options field_opts(const FIELD *field);
ncurses 4.1
1997-05-15 12:00:00 +08:00
.br
.SH DESCRIPTION
The function \fBset_field_opts\fR sets all the given field's option bits (field
option bits may be logically-OR'ed together).
ncurses 5.6
2006-12-18 12:32:42 +08:00
.PP
ncurses 4.1
1997-05-15 12:00:00 +08:00
The function \fBfield_opts_on\fR turns on the given option bits, and leaves
others alone.
ncurses 5.6
2006-12-18 12:32:42 +08:00
.PP
ncurses 4.1
1997-05-15 12:00:00 +08:00
The function \fBfield_opts_off\fR turns off the given option bits, and leaves
others alone.
ncurses 5.6
2006-12-18 12:32:42 +08:00
.PP
ncurses 5.0
1999-10-24 12:32:42 +08:00
The function \fBfield_opts\fR returns the field's current option bits.
ncurses 5.6
2006-12-18 12:32:42 +08:00
.PP
ncurses 4.1
1997-05-15 12:00:00 +08:00
The following options are defined (all are on by default):
.TP 5
O_VISIBLE
The field is displayed. If this option is off, display of the field is
ncurses 5.4
2004-02-09 10:15:26 +08:00
suppressed.
ncurses 4.1
1997-05-15 12:00:00 +08:00
.TP 5
O_ACTIVE
The field is visited during processing. If this option is off, the field will
ncurses 4.2
1998-03-01 12:21:12 +08:00
not be reachable by navigation keys. Please notice that an invisible field
appears to be inactive also.
ncurses 4.1
1997-05-15 12:00:00 +08:00
.TP 5
O_PUBLIC
The field contents are displayed as data is entered.
.TP 5
O_EDIT
The field can be edited.
.TP 5
O_WRAP
ncurses 5.5
2005-10-10 02:41:57 +08:00
Words that do not fit on a line are wrapped to the next line. Words are
ncurses 4.1
1997-05-15 12:00:00 +08:00
blank-separated.
.TP 5
O_BLANK
The field is cleared whenever a character is entered at the first position.
.TP 5
O_AUTOSKIP
ncurses 5.4
2004-02-09 10:15:26 +08:00
Skip to the next field when this one fills.
ncurses 4.1
1997-05-15 12:00:00 +08:00
.TP 5
O_NULLOK
Allow a blank field.
.TP 5
O_STATIC
Field buffers are fixed to field's original size.
ncurses 5.5
2005-10-10 02:41:57 +08:00
Turn this option off to create a dynamic field.
ncurses 4.1
1997-05-15 12:00:00 +08:00
.TP 5
O_PASSOK
Validate field only if modified by user.
.SH RETURN VALUE
Except for \fBfield_opts\fR, each routine returns one of the following:
.TP 5
ncurses 5.6
2006-12-18 12:32:42 +08:00
.B E_OK
ncurses 4.1
1997-05-15 12:00:00 +08:00
The routine succeeded.
.TP 5
ncurses 5.6
2006-12-18 12:32:42 +08:00
.B E_BAD_ARGUMENT
Routine detected an incorrect or out-of-range argument.
ncurses 4.1
1997-05-15 12:00:00 +08:00
.TP 5
ncurses 5.6
2006-12-18 12:32:42 +08:00
.B E_CURRENT
ncurses 4.1
1997-05-15 12:00:00 +08:00
The field is the current field.
ncurses 5.6
2006-12-18 12:32:42 +08:00
.TP 5
.B E_SYSTEM_ERROR
System error occurred (see \fBerrno\fR).
ncurses 4.1
1997-05-15 12:00:00 +08:00
.SH SEE ALSO
\fBcurses\fR(3X), \fBform\fR(3X).
.TP 5
.SH NOTES
The header file \fB<form.h>\fR automatically includes the header file
\fB<curses.h>\fR.
.SH PORTABILITY
These routines emulate the System V forms library. They were not supported on
Version 7 or BSD versions.
.SH AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
S. Raymond.
.\"#
.\"# The following sets edit modes for GNU EMACS
.\"# Local Variables:
.\"# mode:nroff
.\"# fill-column:79
.\"# End:
Reference in New Issue Copy Permalink