X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_field_opts.3x;h=96338e295eef51f2c7d7df770510c14a9e3a359a;hp=58991d3b9af2093436cd8b01374230c43bab7b41;hb=fae162795e065e5901068152e91f2962b6b247f3;hpb=ed8a29294ebe0c24db40d32e9a4e0268afb6529d diff --git a/man/form_field_opts.3x b/man/form_field_opts.3x index 58991d3b..96338e29 100644 --- a/man/form_field_opts.3x +++ b/man/form_field_opts.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2015,2018 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2014,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,7 +28,7 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_opts.3x,v 1.21 2018/04/28 21:24:57 tom Exp $ +.\" $Id: form_field_opts.3x,v 1.27 2020/10/18 00:11:45 tom Exp $ .TH form_field_opts 3X "" .SH NAME \fBset_field_opts\fP, @@ -36,14 +37,14 @@ \fBfield_opts\fP \- set and get field options .SH SYNOPSIS \fB#include \fR +.sp +\fBint set_field_opts(FIELD *\fP\fIfield\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP .br -int set_field_opts(FIELD *field, Field_Options opts); +\fBField_Options field_opts(const FIELD *\fP\fIfield\fP\fB);\fP +.sp +\fBint field_opts_on(FIELD *\fP\fIfield\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP .br -int field_opts_on(FIELD *field, Field_Options opts); -.br -int field_opts_off(FIELD *field, Field_Options opts); -.br -Field_Options field_opts(const FIELD *field); +\fBint field_opts_off(FIELD *\fP\fIfield\fP\fB, Field_Options \fP\fIopts\fP\fB);\fP .br .SH DESCRIPTION The function \fBset_field_opts\fR sets all the given field's option bits (field @@ -60,8 +61,10 @@ The function \fBfield_opts\fR returns the field's current option bits. The following standard options are defined (all are on by default): .TP 5 O_ACTIVE -The field is visited during processing. If this option is off, the field will -not be reachable by navigation keys. Please notice that an invisible field +The field is visited during processing. +If this option is off, the field will +not be reachable by navigation keys. +Please notice that an invisible field appears to be inactive also. .TP 5 O_AUTOSKIP @@ -87,11 +90,13 @@ Field buffers are fixed to field's original size. Turn this option off to create a dynamic field. .TP 5 O_VISIBLE -The field is displayed. If this option is off, display of the field is +The field is displayed. +If this option is off, display of the field is suppressed. .TP 5 O_WRAP -Words that do not fit on a line are wrapped to the next line. Words are +Words that do not fit on a line are wrapped to the next line. +Words are blank-separated. .PP These extension options are defined (extensions are off by default): @@ -110,6 +115,11 @@ but advance the cursor to reflect the insertion. This allows the form library to display the inserted character in one-character fields as well as allowing the library to maintain consistent state. +.TP 5 +O_INPUT_FIELD +The \fBset_max_field\fP function checks for this extension, +which allows a dynamic field to shrink if the new +limit is smaller than the current field size. .SH RETURN VALUE Except for \fBfield_opts\fR, each routine returns one of the following: .TP 5 @@ -123,7 +133,7 @@ Routine detected an incorrect or out-of-range argument. The field is the current field. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR). +System error occurred (see \fBerrno\fR(3)). .SH SEE ALSO \fBcurses\fR(3X), \fBform\fR(3X). @@ -132,8 +142,9 @@ System error occurred (see \fBerrno\fR). The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +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. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.