1form_win(3X)                                                      form_win(3X)
2
3
4

NAME

6       form_win - make and break form window and subwindow associations
7

SYNOPSIS

9       #include <form.h>
10       int set_form_win(FORM *form, WINDOW *win);
11       WINDOW *form_win(const FORM *form);
12       int set_form_sub(FORM *form, WINDOW *sub);
13       WINDOW *form_sub(const FORM *form);
14       int scale_form(const FORM *form, int *rows, int *columns);
15

DESCRIPTION

17       Every  form  has an associated pair of curses windows.  The form window
18       displays any title and border associated with the window; the form sub‐
19       window  displays the items of the form that are currently available for
20       selection.
21
22       The first four functions get and set those windows.  It is  not  neces‐
23       sary  to set either window; by default, the driver code uses stdscr for
24       both.
25
26       In the set_ functions, window argument of NULL is treated as though  it
27       were stsdcr.  A form argument of NULL is treated as a request to change
28       the system default form window or subwindow.
29
30       The function scale_form returns the minimum size required for the  sub‐
31       window of form.
32

RETURN VALUE

34       Routines  that  return  pointers  return  NULL on error.  Routines that
35       return an integer return one of the following error codes:
36
37       E_OK The routine succeeded.
38
39       E_SYSTEM_ERROR
40            System error occurred (see errno(3)).
41
42       E_BAD_ARGUMENT
43            Routine detected an incorrect or out-of-range argument.
44
45       E_POSTED
46            The form has already been posted.
47
48       E_NOT_CONNECTED
49            No items are connected to the form.
50

SEE ALSO

52       curses(3X), curs_variables(3X), form(3X).
53

NOTES

55       The  header  file  <form.h>  automatically  includes  the  header  file
56       <curses.h>.
57

PORTABILITY

59       These  routines emulate the System V forms library.  They were not sup‐
60       ported on Version 7 or BSD versions.
61

AUTHORS

63       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
64       Raymond.
65
66
67
68                                                                  form_win(3X)
Impressum