X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=man%2Fform_field_opts.3x;h=e19f6bd916b16357f453c26f57c80d2d2b7c3056;hb=64eb5fae1961774e65e46953fa536d12c12f6d76;hp=bffcf057db9dc0511bb214be9aa4f5224bead46a;hpb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;p=ncurses.git diff --git a/man/form_field_opts.3x b/man/form_field_opts.3x index bffcf057..e19f6bd9 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-2021,2022 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.22 2018/07/28 21:18:11 tom Exp $ +.\" $Id: form_field_opts.3x,v 1.30 2022/02/12 20:03:40 tom Exp $ .TH form_field_opts 3X "" .SH NAME \fBset_field_opts\fP, @@ -35,27 +36,27 @@ \fBfield_opts_off\fP, \fBfield_opts\fP \- set and get field options .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_field_opts(FIELD *\fIfield\fB, Field_Options \fIopts\fB);\fR .br -int set_field_opts(FIELD *field, Field_Options opts); +\fBField_Options field_opts(const FIELD *\fIfield\fB);\fR +.sp +\fBint field_opts_on(FIELD *\fIfield\fB, Field_Options \fIopts\fB);\fR .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 *\fIfield\fB, Field_Options \fIopts\fB);\fR .br .SH DESCRIPTION -The function \fBset_field_opts\fR sets all the given field's option bits (field +The function \fBset_field_opts\fP sets all the given field's option bits (field option bits may be logically-OR'ed together). .PP -The function \fBfield_opts_on\fR turns on the given option bits, and leaves +The function \fBfield_opts_on\fP turns on the given option bits, and leaves others alone. .PP -The function \fBfield_opts_off\fR turns off the given option bits, and leaves +The function \fBfield_opts_off\fP turns off the given option bits, and leaves others alone. .PP -The function \fBfield_opts\fR returns the field's current option bits. +The function \fBfield_opts\fP returns the field's current option bits. .PP The following standard options are defined (all are on by default): .TP 5 @@ -114,8 +115,13 @@ 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: +Except for \fBfield_opts\fP, each routine returns one of the following: .TP 5 .B E_OK The routine succeeded. @@ -127,14 +133,14 @@ 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\fP(3)). .SH SEE ALSO -\fBcurses\fR(3X), -\fBform\fR(3X). -\fBform_field_just\fR(3X). +\fBcurses\fP(3X), +\fBform\fP(3X). +\fBform_field_just\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on