formwin(3X) formwin(3X)

NAME
       ffoorrmmwwiinn - make and break form window and subwindow associations

SYNOPSIS
       ##iinncclluuddee <>
       int setformwin(FORM *form, WINDOW *win);
       WINDOW *formwin(const FORM *form);
       int setformsub(FORM *form, WINDOW *sub);
       WINDOW *formsub(const FORM *form);
       int scaleform(const FORM *form, int *rows, int *columns);

DESCRIPTION
       Every  form  has an associated pair of ccuurrsseess windows.  The form window
       displays any title and border associated with the window; the form sub-
       window  displays the items of the form that are currently available for
       selection.

       The first four functions get and set those windows.  It is  not  neces-
       sary  to set either window; by default, the driver code uses ssttddssccrr for
       both.

       In the sseett functions, window argument of NNUULLLL is treated as though  it
       were ssttssddccrr.  A form argument of NNUULLLL is treated as a request to change
       the system default form window or subwindow.

       The function ssccaalleeffoorrmm returns the minimum size required for the  sub-
       window of form.

RREETTUURRNN VVAALLUUEE
       Routines  that  return  pointers  return  NNUULLLL on error.  Routines that
       return an integer return one of the following error codes:

       EEOOKK The routine succeeded.

       EESSYYSSTTEEMMEERRRROORR
            System error occurred (see eerrrrnnoo).

       EEBBAADDAARRGGUUMMEENNTT
            Routine detected an incorrect or out-of-range argument.

       EEPPOOSSTTEEDD
            The form has already been posted.

       EENNOOTTCCOONNNNEECCTTEEDD
            No items are connected to the form.

SEE ALSO
       ccuurrsseess(3X), ffoorrmm(3X).

NNOOTTEESS
       The  header  file  <>  automatically  includes  the  header  file
       <>.

PPOORRTTAABBIILLIITTYY
       These  routines emulate the System V forms library.  They were not sup-
       ported on Version 7 or BSD versions.

AUTHORS       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
       Raymond.



                                                                  formwin(3X)