man/form_field_opts.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright (c) 1998-2010,2014 Free Software Foundation, Inc.              *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: form_field_opts.3x,v 1.17 2014/07/26 21:21:57 tom Exp $
  31 .TH form_field_opts 3X ""
  32 .SH NAME
  33 \fBform_field_opts\fR \- set and get field options
  34 .SH SYNOPSIS
  35 \fB#include <form.h>\fR
  36 .br
  37 int set_field_opts(FIELD *field, Field_Options opts);
  38 .br
  39 int field_opts_on(FIELD *field, Field_Options opts);
  40 .br
  41 int field_opts_off(FIELD *field, Field_Options opts);
  42 .br
  43 Field_Options field_opts(const FIELD *field);
  44 .br
  45 .SH DESCRIPTION
  46 The function \fBset_field_opts\fR sets all the given field's option bits (field
  47 option bits may be logically-OR'ed together).
  48 .PP
  49 The function \fBfield_opts_on\fR turns on the given option bits, and leaves
  50 others alone.
  51 .PP
  52 The function \fBfield_opts_off\fR turns off the given option bits, and leaves
  53 others alone.
  54 .PP
  55 The function \fBfield_opts\fR returns the field's current option bits.
  56 .PP
  57 The following standard options are defined (all are on by default):
  58 .TP 5
  59 O_ACTIVE
  60 The field is visited during processing.  If this option is off, the field will
  61 not be reachable by navigation keys. Please notice that an invisible field
  62 appears to be inactive also.
  63 .TP 5
  64 O_AUTOSKIP
  65 Skip to the next field when this one fills.
  66 .TP 5
  67 O_BLANK
  68 The field is cleared whenever a character is entered at the first position.
  69 .TP 5
  70 O_EDIT
  71 The field can be edited.
  72 .TP 5
  73 O_NULLOK
  74 Allow a blank field.
  75 .TP 5
  76 O_PASSOK
  77 Validate field only if modified by user.
  78 .TP 5
  79 O_PUBLIC
  80 The field contents are displayed as data is entered.
  81 .TP 5
  82 O_STATIC
  83 Field buffers are fixed to field's original size.
  84 Turn this option off to create a dynamic field.
  85 .TP 5
  86 O_VISIBLE
  87 The field is displayed.  If this option is off, display of the field is
  88 suppressed.
  89 .TP 5
  90 O_WRAP
  91 Words that do not fit on a line are wrapped to the next line.  Words are
  92 blank-separated.
  93 .PP
  94 One extension option is defined (extensions are off by default):
  95 .TP 5
  96 O_DYNAMIC_JUSTIFY
  97 Permit dynamic fields to be justified, like static fields.
  98 .SH RETURN VALUE
  99 Except for \fBfield_opts\fR, each routine returns one of the following:
 100 .TP 5
 101 .B E_OK
 102 The routine succeeded.
 103 .TP 5
 104 .B E_BAD_ARGUMENT
 105 Routine detected an incorrect or out-of-range argument.
 106 .TP 5
 107 .B E_CURRENT
 108 The field is the current field.
 109 .TP 5
 110 .B E_SYSTEM_ERROR
 111 System error occurred (see \fBerrno\fR).
 112 .SH SEE ALSO
 113 \fBcurses\fR(3X),
 114 \fBform\fR(3X).
 115 \fBform_field_just\fR(3X).
 116 .SH NOTES
 117 The header file \fB<form.h>\fR automatically includes the header file
 118 \fB<curses.h>\fR.
 119 .SH PORTABILITY
 120 These routines emulate the System V forms library.  They were not supported on
 121 Version 7 or BSD versions.
 122 .SH AUTHORS
 123 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 124 S. Raymond.