X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;ds=sidebyside;f=man%2Fform_field_opts.3x;h=56ffc2ed2d098650c43c369080edbefadf3ee06a;hb=HEAD;hp=ff27fe123501b3a5c9cb9819b0331bfa07384739;hpb=c6f54649ed4bf49ec27a522816984d2290201438;p=ncurses.git diff --git a/man/form_field_opts.3x b/man/form_field_opts.3x index ff27fe12..9ab3ad0c 100644 --- a/man/form_field_opts.3x +++ b/man/form_field_opts.3x @@ -1,6 +1,6 @@ -'\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2014 Free Software Foundation, Inc. * +.\" Copyright 2018-2023,2024 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,38 +27,43 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_opts.3x,v 1.17 2014/07/26 21:21:57 tom Exp $ -.TH form_field_opts 3X "" +.\" $Id: form_field_opts.3x,v 1.44 2024/03/16 15:35:01 tom Exp $ +.TH form_field_opts 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME -\fBform_field_opts\fR \- set and get field options +\fBset_field_opts\fP, +\fBfield_opts_on\fP, +\fBfield_opts_off\fP, +\fBfield_opts\fP \- +set and get field options .SH SYNOPSIS -\fB#include \fR -.br -int set_field_opts(FIELD *field, Field_Options opts); -.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); -.br +.nf +\fB#include +.PP +\fBint set_field_opts(FIELD *\fIfield\fP, Field_Options \fIopts\fP); +\fBField_Options field_opts(const FIELD *\fIfield\fP); +.PP +\fBint field_opts_on(FIELD *\fIfield\fP, Field_Options \fIopts\fP); +\fBint field_opts_off(FIELD *\fIfield\fP, Field_Options \fIopts\fP); +.fi .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 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 @@ -84,19 +89,38 @@ 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 -One extension option is defined (extensions are off by default): +These extension options are defined (extensions are off by default): .TP 5 O_DYNAMIC_JUSTIFY Permit dynamic fields to be justified, like static fields. +.TP 5 +O_NO_LEFT_STRIP +Preserve leading whitespace in the field buffer, which is normally discarded. +.TP 5 +O_EDGE_INSERT_STAY +When inserting into a field up to the boundary position, +optionally delay the scrolling, +so that the last inserted character remains visible, +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. @@ -108,17 +132,15 @@ 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). -.SH SEE ALSO -\fBcurses\fR(3X), -\fBform\fR(3X). -\fBform_field_just\fR(3X). -.SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +System error occurred (see \fBerrno\fP(3)). .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. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X), +\fB\%form_field_just\fP(3X)