X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_opts.3x.html;h=c9a1205e3e1ec0b84b1aa303463c7829ccecd60f;hb=f344f8539c1543f8cd65a5bb142dbaf23b9421d2;hp=e1c453e9e744aee00fe0ed8d1c321347467d99ee;hpb=f9d358b4f3cf9b44727a0ee5c08f8ca6ae4e3821;p=ncurses.git diff --git a/doc/html/man/form_field_opts.3x.html b/doc/html/man/form_field_opts.3x.html index e1c453e9..c9a1205e 100644 --- a/doc/html/man/form_field_opts.3x.html +++ b/doc/html/man/form_field_opts.3x.html @@ -1,8 +1,7 @@ - +
+ +- form_field_opts(3x) form_field_opts(3x) --
- form_field_opts - set and get field options +
+ set_field_opts, field_opts_on, field_opts_off, field_opts + - set and get field options --
+
#include <form.h> int set_field_opts(FIELD *field, Field_Options opts); int field_opts_on(FIELD *field, Field_Options opts); @@ -60,70 +59,80 @@ Field_Options field_opts(const FIELD *field); --
- The function set_field_opts sets all the given field's - option bits (field option bits may be logically-OR'ed +
+ The function set_field_opts sets all the given field's + option bits (field option bits may be logically-OR'ed together). The function field_opts_on turns on the given option bits, and leaves others alone. - The function field_opts_off turns off the given option + The function field_opts_off turns off the given option bits, and leaves others alone. The function field_opts returns the field's current option bits. - The following options are defined (all are on by default): - - O_VISIBLE - The field is displayed. If this option is off, dis- - play of the field is suppressed. + The following standard options are defined (all are on by + default): 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 + 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. - O_PUBLIC - The field contents are displayed as data is entered. - - O_EDIT - The field can be edited. - - O_WRAP - Words that do not 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. O_BLANK The field is cleared whenever a character is entered at the first position. - O_AUTOSKIP - Skip to the next field when this one fills. + O_EDIT + The field can be edited. O_NULLOK Allow a blank field. + O_PASSOK + Validate field only if modified by user. + + O_PUBLIC + The field contents are displayed as data is entered. + O_STATIC Field buffers are fixed to field's original size. Turn this option off to create a dynamic field. - O_PASSOK - Validate field only if modified by user. + O_VISIBLE + The field is displayed. If this option is off, dis- + play of the field is suppressed. + O_WRAP + Words that do not fit on a line are wrapped to the + next line. Words are blank-separated. --
- Except for field_opts, each routine returns one of the + These extension options are defined (extensions are off by + default): + + O_DYNAMIC_JUSTIFY + Permit dynamic fields to be justified, like static + fields. + + O_NO_LEFT_STRIP + Preserve leading whitespace in the field buffer, + which is normally discarded. + + +
+ Except for field_opts, each routine returns one of the following: E_OK The routine succeeded. E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- + Routine detected an incorrect or out-of-range argu- ment. E_CURRENT @@ -133,36 +142,39 @@ System error occurred (see errno). --
- curses(3x), form(3x). +
+ curses(3x), form(3x). form_field_just(3x). --
+
The header file <form.h> automatically includes the header file <curses.h>. --
- These routines emulate the System V forms library. They +
+ These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions. --
- Juergen Pfeifer. Manual pages and adaptation for new +
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. form_field_opts(3x)-