X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_opts.3x.html;h=46441b8dbd7ddebb2f48b5884ddc101de575a3ba;hp=db1e41f7263008eedfdde5362c500a9378329d6d;hb=9f479192e3ca3413d235c66bf058f8cc63764898;hpb=bca50d0d8592defee6c584fdedd25f4b1a31345b diff --git a/doc/html/man/form_field_opts.3x.html b/doc/html/man/form_field_opts.3x.html index db1e41f7..46441b8d 100644 --- a/doc/html/man/form_field_opts.3x.html +++ b/doc/html/man/form_field_opts.3x.html @@ -1,7 +1,8 @@ - -form_field_opts 3x - +form_field_opts 3X + -

form_field_opts 3x

+

form_field_opts 3X

-form_field_opts(3x)                                        form_field_opts(3x)
+form_field_opts(3X)                                        form_field_opts(3X)

NAME

-       set_field_opts, field_opts_on, field_opts_off, field_opts - set and get
+       set_field_opts, field_opts_on, field_opts_off, field_opts - set and get
        field options

SYNOPSIS

-       #include <form.h>
-       int set_field_opts(FIELD *field, Field_Options opts);
-       int field_opts_on(FIELD *field, Field_Options opts);
-       int field_opts_off(FIELD *field, Field_Options opts);
-       Field_Options field_opts(const FIELD *field);
+       #include <form.h>
+
+       int set_field_opts(FIELD *field, Field_Options opts);
+       Field_Options field_opts(const FIELD *field);
+
+       int field_opts_on(FIELD *field, Field_Options opts);
+       int field_opts_off(FIELD *field, Field_Options opts);

DESCRIPTION

-       The function set_field_opts sets all  the  given  field's  option  bits
+       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
+       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 bits, and leaves
+       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 function field_opts returns the field's current option bits.
 
        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
+            the field will not be reachable by navigation keys.  Please notice
             that an invisible field appears to be inactive also.
 
        O_AUTOSKIP
@@ -118,34 +121,47 @@
             Preserve leading whitespace in the field buffer, which is normally
             discarded.
 
+       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.
+
+       O_INPUT_FIELD
+            The set_max_field function checks for this extension, which allows
+            a dynamic field to shrink if the new limit  is  smaller  than  the
+            current field size.
+

RETURN VALUE

-       Except for field_opts, each routine returns one of the following:
+       Except for field_opts, each routine returns one of the following:
 
-       E_OK The routine succeeded.
+       E_OK The routine succeeded.
 
-       E_BAD_ARGUMENT
+       E_BAD_ARGUMENT
             Routine detected an incorrect or out-of-range argument.
 
-       E_CURRENT
+       E_CURRENT
             The field is the current field.
 
-       E_SYSTEM_ERROR
-            System error occurred (see errno).
+       E_SYSTEM_ERROR
+            System error occurred (see errno(3)).

SEE ALSO

-       curses(3x), form(3x).  form_field_just(3x).
+       curses(3X), form(3X).  form_field_just(3X).

NOTES

-       The  header  file  <form.h>  automatically  includes  the  header  file
-       <curses.h>.
+       The  header  file  <form.h>  automatically  includes  the  header  file
+       <curses.h>.

PORTABILITY

-       These  routines emulate the System V forms library.  They were not sup-
-       ported on Version 7 or BSD versions.
+       These routines emulate the System  V  forms  library.   They  were  not
+       supported on Version 7 or BSD versions.

AUTHORS

@@ -154,7 +170,7 @@
 
 
 
-                                                           form_field_opts(3x)
+                                                           form_field_opts(3X)