ncurses 6.1 - patch 20180728
[ncurses.git] / man / form_win.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2010,2018 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_win.3x,v 1.14 2018/07/28 21:34:06 tom Exp $
31 .TH form_win 3X ""
32 .SH NAME
33 \fBform_win\fR \- make and break form window and subwindow associations
34 .SH SYNOPSIS
35 \fB#include <form.h>\fR
36 .br
37 int set_form_win(FORM *form, WINDOW *win);
38 .br
39 WINDOW *form_win(const FORM *form);
40 .br
41 int set_form_sub(FORM *form, WINDOW *sub);
42 .br
43 WINDOW *form_sub(const FORM *form);
44 .br
45 int scale_form(const FORM *form, int *rows, int *columns);
46 .br
47 .SH DESCRIPTION
48 Every form has an associated pair of \fBcurses\fR windows.
49 The form window
50 displays any title and border associated with the window; the form subwindow
51 displays the items of the form that are currently available for selection.
52 .PP
53 The first four functions get and set those windows.
54 It is not necessary to set
55 either window; by default, the driver code uses \fBstdscr\fR for both.
56 .PP
57 In the \fBset_\fR functions, window argument of \fBNULL\fR is treated as though
58 it were \fBstsdcr\fR.  A form argument of \fBNULL\fR is treated as a request
59 to change the system default form window or subwindow.
60 .PP
61 The function \fBscale_form\fR returns the minimum size required for the
62 subwindow of \fIform\fR.
63 .SH RETURN VALUE
64 Routines that return pointers return \fBNULL\fR on error.
65 Routines that return
66 an integer return one of the following error codes:
67 .TP 5
68 .B E_OK
69 The routine succeeded.
70 .TP 5
71 .B E_SYSTEM_ERROR
72 System error occurred (see \fBerrno\fR).
73 .TP 5
74 .B E_BAD_ARGUMENT
75 Routine detected an incorrect or out-of-range argument.
76 .TP 5
77 .B E_POSTED
78 The form has already been posted.
79 .TP 5
80 .B E_NOT_CONNECTED
81 No items are connected to the form.
82 .SH SEE ALSO
83 \fBcurses\fR(3X),
84 \fBcurs_variables\fR(3X),
85 \fBform\fR(3X).
86 .SH NOTES
87 The header file \fB<form.h>\fR automatically includes the header file
88 \fB<curses.h>\fR.
89 .SH PORTABILITY
90 These routines emulate the System V forms library.
91 They were not supported on
92 Version 7 or BSD versions.
93 .SH AUTHORS
94 Juergen Pfeifer.
95 Manual pages and adaptation for new curses by Eric S. Raymond.