lib/libform/form_opts.3

   1 .\"     $NetBSD: form_opts.3,v 1.8 2004/11/24 12:12:20 wiz Exp $
   2 .\"
   3 .\" Copyright (c) 2001
   4 .\"     Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
   5 .\"
   6 .\" This code is donated to The NetBSD Foundation by the author.
   7 .\"
   8 .\" Redistribution and use in source and binary forms, with or without
   9 .\" modification, are permitted provided that the following conditions
  10 .\" are met:
  11 .\" 1. Redistributions of source code must retain the above copyright
  12 .\"    notice, this list of conditions and the following disclaimer.
  13 .\" 2. Redistributions in binary form must reproduce the above copyright
  14 .\"    notice, this list of conditions and the following disclaimer in the
  15 .\"    documentation and/or other materials provided with the distribution.
  16 .\" 3. The name of the Author may not be used to endorse or promote
  17 .\"    products derived from this software without specific prior written
  18 .\"    permission.
  19 .\"
  20 .\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
  21 .\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
  22 .\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
  23 .\" ARE DISCLAIMED.  IN NO EVENT SHALL THE AUTHOR BE LIABLE
  24 .\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
  25 .\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
  26 .\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
  27 .\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
  28 .\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
  29 .\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
  30 .\" SUCH DAMAGE.
  31 .\"
  32 .Dd January 1, 2001
  33 .Dt FORMS 3
  34 .Os
  35 .Sh NAME
  36 .Nm form_opts ,
  37 .Nm form_opts_off ,
  38 .Nm form_opts_on ,
  39 .Nm set_form_opts
  40 .Nd form library
  41 .Sh LIBRARY
  42 .Lb libform
  43 .Sh SYNOPSIS
  44 .In form.h
  45 .Ft Form_Options
  46 .Fn form_opts "FORM *form"
  47 .Ft int
  48 .Fn form_opts_off "FORM *form" "Form_Options options"
  49 .Ft int
  50 .Fn form_opts_on "FORM *form" "Form_Options options"
  51 .Ft int
  52 .Fn set_form_opts "FORM *form" "Form_Options options"
  53 .Sh DESCRIPTION
  54 The function
  55 .Fn form_opts
  56 returns the current options that are set on the given form.
  57 The
  58 .Fn form_opts_off
  59 will turn off the form options given in
  60 .Fa options
  61 for the form, similarly,
  62 .Fn form_opts_on
  63 will turn on the options specified in
  64 .Fa options
  65 for the given form.
  66 The form options can be set to an explicit set by calling
  67 .Fn set_form_opts .
  68 .Sh PARAMETERS
  69 The following form options are valid:
  70 .Pp
  71 .Bl -tag -width O_BS_OVERLOAD -compact
  72 .It O_BS_OVERLOAD
  73 If this option is set and the cursor is at the first character in the
  74 field then the backspace character will perform the same function as a
  75 REQ_PREV_FIELD driver request, moving to the previous field in the
  76 form.
  77 .It O_NL_OVERLOAD
  78 If this option is set and the cursor is at the end of the field then
  79 the new line character will perform the same function as a
  80 REQ_NEXT_FIELD driver request, moving to the next field in the form.
  81 .El
  82 .Pp
  83 By default no form options are set.
  84 .Sh RETURN VALUES
  85 Functions returning pointers will return
  86 .Dv NULL
  87 if an error is detected.
  88 The functions that return an int will return one of the following error
  89 values:
  90 .Pp
  91 .Bl -tag -width E_UNKNOWN_COMMAND -compact
  92 .It Er E_OK
  93 The function was successful.
  94 .El
  95 .Sh SEE ALSO
  96 .Xr curses 3 ,
  97 .Xr forms 3
  98 .Sh NOTES
  99 The header
 100 .Aq Pa form.h
 101 automatically includes both
 102 .Aq Pa curses.h
 103 and
 104 .Aq Pa eti.h .