lib/libncurses/man/form_field_opts.3

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright (c) 1998,2003 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.8 2003/05/10 20:33:49 jmc Exp $
  31 .\" $DragonFly: src/lib/libncurses/man/form_field_opts.3,v 1.1 2005/03/12 19:13:54 eirikn Exp $
  32 .TH form_field_opts 3X ""
  33 .SH NAME
  34 \fBform_field_opts\fR - set and get field options
  35 .SH SYNOPSIS
  36 \fB#include <form.h>\fR
  37 .br
  38 int set_field_opts(FIELD *field, OPTIONS opts);
  39 .br
  40 int field_opts_on(FIELD *field, OPTIONS opts);
  41 .br
  42 int field_opts_off(FIELD *field, OPTIONS opts);
  43 .br
  44 OPTIONS field_opts(const FIELD *field);
  45 .br
  46 .SH DESCRIPTION
  47 The function \fBset_field_opts\fR sets all the given field's option bits (field
  48 option bits may be logically-OR'ed together).
  49
  50 The function \fBfield_opts_on\fR turns on the given option bits, and leaves
  51 others alone.
  52
  53 The function \fBfield_opts_off\fR turns off the given option bits, and leaves
  54 others alone.
  55
  56 The function \fBfield_opts\fR returns the field's current option bits.
  57
  58 The following options are defined (all are on by default):
  59 .TP 5
  60 O_VISIBLE
  61 The field is displayed.  If this option is off, display of the field is
  62 suppressed.
  63 .TP 5
  64 O_ACTIVE
  65 The field is visited during processing.  If this option is off, the field will
  66 not be reachable by navigation keys. Please notice that an invisible field
  67 appears to be inactive also.
  68 .TP 5
  69 O_PUBLIC
  70 The field contents are displayed as data is entered.
  71 .TP 5
  72 O_EDIT
  73 The field can be edited.
  74 .TP 5
  75 O_WRAP
  76 Words that don't fit on a line are wrapped to the next line.  Words are
  77 blank-separated.
  78 .TP 5
  79 O_BLANK
  80 The field is cleared whenever a character is entered at the first position.
  81 .TP 5
  82 O_AUTOSKIP
  83 Skip to the next field when this one fills.
  84 .TP 5
  85 O_NULLOK
  86 Allow a blank field.
  87 .TP 5
  88 O_STATIC
  89 Field buffers are fixed to field's original size.
  90 .TP 5
  91 O_PASSOK
  92 Validate field only if modified by user.
  93 .SH RETURN VALUE
  94 Except for \fBfield_opts\fR, each routine returns one of the following:
  95 .TP 5
  96 \fBE_OK\fR
  97 The routine succeeded.
  98 .TP 5
  99 \fBE_SYSTEM_ERROR\fR
 100 System error occurred (see \fBerrno\fR).
 101 .TP 5
 102 \fBE_CURRENT\fR
 103 The field is the current field.
 104 .SH SEE ALSO
 105 \fBcurses\fR(3X), \fBform\fR(3X).
 106 .TP 5
 107 .SH NOTES
 108 The header file \fB<form.h>\fR automatically includes the header file
 109 \fB<curses.h>\fR.
 110 .SH PORTABILITY
 111 These routines emulate the System V forms library.  They were not supported on
 112 Version 7 or BSD versions.
 113 .SH AUTHORS
 114 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 115 S. Raymond.
 116 .\"#
 117 .\"# The following sets edit modes for GNU EMACS
 118 .\"# Local Variables:
 119 .\"# mode:nroff
 120 .\"# fill-column:79
 121 .\"# End: