X-Git-Url: http://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_opts.3x.html;h=e1c453e9e744aee00fe0ed8d1c321347467d99ee;hp=576dcad8a2701297ac6e6f2d297e0f3f8e7bb325;hb=f9d358b4f3cf9b44727a0ee5c08f8ca6ae4e3821;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/form_field_opts.3x.html b/doc/html/man/form_field_opts.3x.html index 576dcad8..e1c453e9 100644 --- a/doc/html/man/form_field_opts.3x.html +++ b/doc/html/man/form_field_opts.3x.html @@ -1,57 +1,100 @@ + + +
++form_field_opts(3x) form_field_opts(3x) + + +
- form_field_opts - set and get field options + form_field_opts - set and get field options
- #include <form.h> - int set_field_opts(FIELD *field, OPTIONS opts); - int field_opts_on(FIELD *field, OPTIONS opts); - int field_opts_off(FIELD *field, OPTIONS opts); - OPTIONS field_opts(const FIELD *field); + #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);
- The function set_field_opts sets all the given field's + 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, + 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 + 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 field is displayed. If this option is off, dis- + play of the field is suppressed. 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. + The field contents are displayed as data is entered. O_EDIT The field can be edited. O_WRAP - Words that don't fit on a line are wrapped to the + Words that do not fit on a line are wrapped to the next line. Words are blank-separated. O_BLANK @@ -59,14 +102,14 @@ at the first position. O_AUTOSKIP - Skip to the next field when this one fills - + Skip to the next field when this one fills. O_NULLOK Allow a blank field. O_STATIC - Field buffers are fixed to field's original size. + 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. @@ -74,25 +117,31 @@
- Except for field_opts, each routine returns one of the + Except for field_opts, each routine returns one of the following: - E_OK The routine succeeded. + E_OK The routine succeeded. - E_SYSTEM_ERROR - System error occurred (see errno). + E_BAD_ARGUMENT + Routine detected an incorrect or out-of-range argu- + ment. - E_CURRENT + E_CURRENT The field is the current field. + E_SYSTEM_ERROR + System error occurred (see errno). +
- curses(3x), form(3x). + curses(3x), form(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>.@@ -108,22 +157,7 @@ - - - - - - - - - - - - - - - - + form_field_opts(3x)