diff options
Diffstat (limited to 'man/form_field_opts.3x')
| -rw-r--r-- | man/form_field_opts.3x | 50 |
1 files changed, 38 insertions, 12 deletions
diff --git a/man/form_field_opts.3x b/man/form_field_opts.3x index ff27fe1..14f9a20 100644 --- a/man/form_field_opts.3x +++ b/man/form_field_opts.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2014 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,10 +28,13 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_opts.3x,v 1.17 2014/07/26 21:21:57 tom Exp $ +.\" $Id: form_field_opts.3x,v 1.25 2020/02/02 23:34:34 tom Exp $ .TH form_field_opts 3X "" .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 <form.h>\fR .br @@ -57,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 @@ -84,17 +90,36 @@ 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: .TP 5 @@ -108,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). @@ -117,8 +142,9 @@ System error occurred (see \fBerrno\fR). 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 +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. |