ncurses 6.0 - patch 20151128

[ncurses.git] / man / form_field_opts.3x

diff --git a/man/form_field_opts.3x b/man/form_field_opts.3x
index 8f5e2def4315aa01d92c2c35f40bbc22600f7e02..f1249a3880cde5df64d1a6c560a4256386959348 100644 (file)
--- a/man/form_field_opts.3x
+++ b/man/form_field_opts.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *
+.\" Copyright (c) 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,82 +27,95 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form_field_opts.3x,v 1.7 1998/11/29 01:06:54 Rick.Ohnemus Exp $
+.\" $Id: form_field_opts.3x,v 1.19 2015/11/28 20:40:13 tom Exp $
 .TH form_field_opts 3X ""
 .SH NAME
-\fBform_field_opts\fR - set and get field options
+\fBform_field_opts\fR \- set and get field options
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br
-int set_field_opts(FIELD *field, OPTIONS opts);
+int set_field_opts(FIELD *field, Field_Options opts);
 .br
-int field_opts_on(FIELD *field, OPTIONS opts);
+int field_opts_on(FIELD *field, Field_Options opts);
 .br
-int field_opts_off(FIELD *field, OPTIONS opts);
+int field_opts_off(FIELD *field, Field_Options opts);
 .br
-OPTIONS field_opts(const FIELD *field);
+Field_Options field_opts(const FIELD *field);
 .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).
-
+.PP
 The function \fBfield_opts_on\fR 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
 others alone.
-
+.PP
 The function \fBfield_opts\fR returns the field's current option bits.
-
-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
-suppressed,
+.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
 appears to be inactive also.
 .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
-Words that don't fit on a line are wrapped to the next line.  Words are
-blank-separated.
+O_AUTOSKIP
+Skip to the next field when this one fills.
 .TP 5
 O_BLANK
 The field is cleared whenever a character is entered at the first position.
 .TP 5
-O_AUTOSKIP
-Skip to the next field when this one fills
+O_EDIT
+The field can be edited.
 .TP 5
 O_NULLOK
 Allow a blank field.
 .TP 5
+O_PASSOK
+Validate field only if modified by user.
+.TP 5
+O_PUBLIC
+The field contents are displayed as data is entered.
+.TP 5
 O_STATIC
 Field buffers are fixed to field's original size.
+Turn this option off to create a dynamic field.
 .TP 5
-O_PASSOK
-Validate field only if modified by user.
+O_VISIBLE
+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
+blank-separated.
+.PP
+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.
 .SH RETURN VALUE
 Except for \fBfield_opts\fR, each routine returns one of the following:
 .TP 5
-\fBE_OK\fR
+.B E_OK
 The routine succeeded.
 .TP 5
-\fBE_SYSTEM_ERROR\fR
-System error occurred (see \fBerrno\fR).
+.B E_BAD_ARGUMENT
+Routine detected an incorrect or out-of-range argument.
 .TP 5
-\fBE_CURRENT\fR
+.B E_CURRENT
 The field is the current field.
-.SH SEE ALSO
-\fBcurses\fR(3X), \fBform\fR(3X).
 .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<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
@@ -112,9 +125,3 @@ 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: