X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_field_opts.3x.html;h=12758e1247722df6b5e476e7e64c1d236eced2c4;hp=576dcad8a2701297ac6e6f2d297e0f3f8e7bb325;hb=c6cfd97b8beaf0f6deafbf8aac7281cf6aa7f012;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34 diff --git a/doc/html/man/form_field_opts.3x.html b/doc/html/man/form_field_opts.3x.html index 576dcad8..12758e12 100644 --- a/doc/html/man/form_field_opts.3x.html +++ b/doc/html/man/form_field_opts.3x.html @@ -1,134 +1,184 @@ + + +
+ + +- +form_field_opts(3x) form_field_opts(3x) + + +-
- form_field_opts - set and get field options +NAME
+ form_field_opts - set and get field options-SYNOPSIS
- #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); +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);-DESCRIPTION
- The function set_field_opts sets all the given field's +DESCRIPTION
+ 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 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 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. O_BLANK - The field is cleared whenever a character is entered + 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_STATIC - Field buffers are fixed to field's original size. - O_PASSOK Validate field only if modified by user. + O_PUBLIC + The field contents are displayed as data is entered. --RETURN VALUE
- Except for field_opts, each routine returns one of the - following: - - E_OK The routine succeeded. - - E_SYSTEM_ERROR - System error occurred (see errno). - - E_CURRENT - The field is the current field. - - --SEE ALSO
- curses(3x), form(3x). + O_STATIC + Field buffers are fixed to field's original size. + Turn this option off to create a dynamic field. + O_VISIBLE + The field is displayed. If this option is off, dis- + play of the field is suppressed. - NOTES The header file <form.h> automatically includes the - header file <curses.h>. + O_WRAP + Words that do not fit on a line are wrapped to the + next line. Words are blank-separated. + One extension option is defined (extensions are off by + default): --PORTABILITY
- These routines emulate the System V forms library. They - were not supported on Version 7 or BSD versions. + O_DYNAMIC_JUSTIFY + Permit dynamic fields to be justified, like static + fields.-AUTHORS
- Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. - - - - +RETURN VALUE
+ 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- + ment. + E_CURRENT + The field is the current field. + E_SYSTEM_ERROR + System error occurred (see errno). ++SEE ALSO
+ curses(3x), form(3x). form_field_just(3x). ++NOTES
+ The header file <form.h> automatically includes the header + file <curses.h>. ++PORTABILITY
+ These routines emulate the System V forms library. They + were not supported on Version 7 or BSD versions. ++AUTHORS
+ Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + form_field_opts(3x)-
- -Man(1) output converted with -man2html - +