form_field_opts(3curses)


form_field_opts: set_field_opts, field_opts_on, field_opts_off, field_opts -- forms field option routines

Synopsis

   cc [flag . . .] file -lform -lcurses [library . . .] 
   

#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(FIELD *field);

Description

set_field_opts turns on the named options of field and turns off all remaining options. Options are boolean values that can be OR-ed together.

field_opts_on turns on the named options; no other options are changed.

field_opts_off turns off the named options; no other options are changed.

field_opts returns the options set for field.

Field Options: O_VISIBLE
The field is displayed.    
O_ACTIVE The field is visited during processing.  
O_PUBLIC The field contents are displayed as data is entered.  
O_EDIT The field can be edited.  
O_WRAP Words not fitting on a line are wrapped to the next line.  
O_BLANK The whole field is cleared if a character is entered in the first position.  
O_AUTOSKIP Skip to the next field when the current field becomes full.  
O_NULLOK A blank field is considered valid.  
O_STATIC The field buffers are fixed in size.  
O_PASSOK Validate field only if modified by user.  

 
 Field Options: 
 O_VISIBLE      The field is displayed. 
 O_ACTIVE       The field is visited during processing. 
 O_PUBLIC       The field contents are displayed as data is entered. 
 O_EDIT         The field can be edited. 
 O_WRAP         Words not fitting on a line are wrapped to the next line. 
 O_BLANK        The whole field is cleared if a character is entered in the 
                first position. 
 O_AUTOSKIP     Skip to the next field when the current field becomes full. 
 O_NULLOK       A blank field is considered valid. 
 O_STATIC       The field buffers are fixed in size. 
 O_PASSOK       Validate field only if modified by user. 

<Return> value

set_field_opts, field_opts_on and field_opts_off return one of the following:

E_OK - The function returned successfully.
E_SYSTEM_ERROR - System error.
E_CURRENT - The field is the current field.

 
 E_OK             -   The function returned successfully. 
 E_SYSTEM_ERROR   -   System error. 
 E_CURRENT        -   The field is the current field. 

Notices

The header file form.h automatically includes the header files eti.h and curses.h.

References

curses(3curses), forms(3curses)
30 January 1998
© 1998 The Santa Cruz Operation, Inc. All rights reserved.