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