ncurses 5.3
[ncurses.git] / doc / html / man / form_win.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998 Free Software Foundation, Inc.                        *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: form_win.3x,v 1.8 1999/04/10 23:36:08 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_win 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>form_win 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>form_win</STRONG>  - make and break form window and subwindow asso-
48        ciations
49
50
51 </PRE>
52 <H2>SYNOPSIS</H2><PRE>
53        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
54        int set_form_win(FORM *form, WINDOW *win);
55        WINDOW *form_win(const FORM *form);
56        int set_form_sub(FORM *form, WINDOW *sub);
57        WINDOW *form_sub(const FORM *form);
58        int scale_form(const FORM *form, int *rows, int *columns);
59
60
61 </PRE>
62 <H2>DESCRIPTION</H2><PRE>
63        Every  form has an associated pair of <STRONG>curses</STRONG> windows.  The
64        form window displays any title and border associated  with
65        the  window;  the form subwindow displays the items of the
66        form that are currently available for selection.
67
68        The first four functions get and set those windows.  It is
69        not necessary to set either window; by default, the driver
70        code uses <STRONG>stdscr</STRONG> for both.
71
72        In the <STRONG>set_</STRONG> functions, window argument of <STRONG>NULL</STRONG> is  treated
73        as  though  it  were  <STRONG>stsdcr</STRONG>.   A form argument of <STRONG>NULL</STRONG> is
74        treated as a request to change  the  system  default  form
75        window or subwindow.
76
77        The  function <STRONG>scale_form</STRONG> returns the minimum size required
78        for the subwindow of <EM>form</EM>.
79
80
81 </PRE>
82 <H2>RETURN VALUE</H2><PRE>
83        Routines that return pointers return <STRONG>NULL</STRONG> on error.   Rou-
84        tines  that  return an integer return one of the following
85        error codes:
86
87        <STRONG>E_OK</STRONG> The routine succeeded.
88
89        <STRONG>E_SYSTEM_ERROR</STRONG>
90             System error occurred (see <STRONG>errno</STRONG>).
91
92        <STRONG>E_BAD_ARGUMENT</STRONG>
93             Routine detected an incorrect or  out-of-range  argu-
94             ment.
95
96        <STRONG>E_POSTED</STRONG>
97             The form has already been posted.
98
99        <STRONG>E_NOT_CONNECTED</STRONG>
100             No items are connected to the form.
101
102
103 </PRE>
104 <H2>SEE ALSO</H2><PRE>
105        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
106
107
108
109 </PRE>
110 <H2>NOTES</H2><PRE>
111        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
112        file <STRONG>&lt;curses.h&gt;</STRONG>.
113
114
115 </PRE>
116 <H2>PORTABILITY</H2><PRE>
117        These routines emulate the System V forms  library.   They
118        were not supported on Version 7 or BSD versions.
119
120
121 </PRE>
122 <H2>AUTHORS</H2><PRE>
123        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
124        curses by Eric S. Raymond.
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168 </PRE>
169 <HR>
170 <ADDRESS>
171 Man(1) output converted with
172 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
173 </ADDRESS>
174 </BODY>
175 </HTML>