ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / form_win.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2006,2010 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.16 2020/02/02 23:34:34 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>form_win 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">form_win 3x</H1>
44 <PRE>
45 <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>                                                      <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>form_win</STRONG> - make and break form window and subwindow associations
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
56        int set_form_win(FORM *form, WINDOW *win);
57        WINDOW *form_win(const FORM *form);
58        int set_form_sub(FORM *form, WINDOW *sub);
59        WINDOW *form_sub(const FORM *form);
60        int scale_form(const FORM *form, int *rows, int *columns);
61
62
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64        Every  form  has an associated pair of <STRONG>curses</STRONG> windows.  The form window
65        displays any title and border associated with the window; the form sub-
66        window  displays the items of the form that are currently available for
67        selection.
68
69        The first four functions get and set those windows.  It is  not  neces-
70        sary  to set either window; by default, the driver code uses <STRONG>stdscr</STRONG> for
71        both.
72
73        In the <STRONG>set_</STRONG> functions, window argument of <STRONG>NULL</STRONG> is treated as though  it
74        were <STRONG>stsdcr</STRONG>.  A form argument of <STRONG>NULL</STRONG> is treated as a request to change
75        the system default form window or subwindow.
76
77        The function <STRONG>scale_form</STRONG> returns the minimum size required for the  sub-
78        window of <EM>form</EM>.
79
80
81 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
82        Routines  that  return  pointers  return  <STRONG>NULL</STRONG> on error.  Routines that
83        return an integer return one of the following error codes:
84
85        <STRONG>E_OK</STRONG> The routine succeeded.
86
87        <STRONG>E_SYSTEM_ERROR</STRONG>
88             System error occurred (see <STRONG>errno(3)</STRONG>).
89
90        <STRONG>E_BAD_ARGUMENT</STRONG>
91             Routine detected an incorrect or out-of-range argument.
92
93        <STRONG>E_POSTED</STRONG>
94             The form has already been posted.
95
96        <STRONG>E_NOT_CONNECTED</STRONG>
97             No items are connected to the form.
98
99
100 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
101        <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>.
102
103
104 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
105        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
106        <STRONG>&lt;curses.h&gt;</STRONG>.
107
108
109 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
110        These  routines emulate the System V forms library.  They were not sup-
111        ported on Version 7 or BSD versions.
112
113
114 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
115        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
116        Raymond.
117
118
119
120                                                                   <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
121 </PRE>
122 <div class="nav">
123 <ul>
124 <li><a href="#h2-NAME">NAME</a></li>
125 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
126 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
127 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
128 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
129 <li><a href="#h2-NOTES">NOTES</a></li>
130 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
131 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
132 </ul>
133 </div>
134 </BODY>
135 </HTML>