lib/libform/form_win.3

   1 .\"     $NetBSD: form_win.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_sub ,
  37 .Nm form_win ,
  38 .Nm scale_form ,
  39 .Nm set_form_sub ,
  40 .Nm set_form_win
  41 .Nd form library
  42 .Sh LIBRARY
  43 .Lb libform
  44 .Sh SYNOPSIS
  45 .In form.h
  46 .Ft WINDOW *
  47 .Fn form_sub "FORM *form"
  48 .Ft WINDOW *
  49 .Fn form_win "FORM *form"
  50 .Ft int
  51 .Fn scale_form "FORM *form" "int *rows" "int *cols"
  52 .Ft int
  53 .Fn set_form_sub "FORM *form" "WINDOW *window"
  54 .Ft int
  55 .Fn set_form_win "FORM *form" "WINDOW *window"
  56 .Sh DESCRIPTION
  57 All output to the screen done by the forms library is handled by the
  58 curses library routines.
  59 By default, the forms library will output to the curses
  60 .Fa stdscr ,
  61 but if the forms window has been set via
  62 .Fn set_form_win
  63 then output will be sent to the window specified by
  64 .Fn set_form_win ,
  65 unless the forms subwindow has been set using
  66 .Fn set_form_sub .
  67 If a subwindow has been specified using
  68 .Fn set_form_sub
  69 then it will be used by the forms library to for screen output.
  70 The current setting for the form window can be retrieved by calling
  71 .Fn form_win .
  72 If the forms window has not been set then
  73 .Dv NULL
  74 will be returned.
  75 Similarly, the forms subwindow can be found by calling the
  76 .Fn form_sub
  77 function, again, if the subwindow has not been set then
  78 .Dv NULL
  79 will be
  80 returned.
  81 The
  82 .Fn scale_form
  83 function will return the minimum number of rows and columns that will
  84 entirely contain the given form.
  85 .Sh RETURN VALUES
  86 Functions returning pointers will return
  87 .Dv NULL
  88 if an error is detected.
  89 The functions that return an int will return one of the following error
  90 values:
  91 .Pp
  92 .Bl -tag -width E_UNKNOWN_COMMAND -compact
  93 .It Er E_OK
  94 The function was successful.
  95 .It Er E_NOT_CONNECTED
  96 The form has no fields connected to it.
  97 .It Er E_POSTED
  98 The form is posted to the screen.
  99 .El
 100 .Sh SEE ALSO
 101 .Xr curses 3 ,
 102 .Xr forms 3
 103 .Sh NOTES
 104 The header
 105 .Aq Pa form.h
 106 automatically includes both
 107 .Aq Pa curses.h
 108 and
 109 .Aq Pa eti.h .