ncurses 6.0 - patch 20170114
[ncurses.git] / doc / html / man / form_win.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2006,2010 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.13 2010/12/04 18:38:55 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 http://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 asso-
51        ciations
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
65        form  window displays any title and border associated with
66        the window; the form subwindow displays the items  of  the
67        form that are currently available for selection.
68
69        The first four functions get and set those windows.  It is
70        not necessary to set either window; by default, the driver
71        code uses <STRONG>stdscr</STRONG> for both.
72
73        In  the <STRONG>set_</STRONG> functions, window argument of <STRONG>NULL</STRONG> is treated
74        as though it were <STRONG>stsdcr</STRONG>.  A  form  argument  of  <STRONG>NULL</STRONG>  is
75        treated  as  a  request  to change the system default form
76        window or subwindow.
77
78        The function <STRONG>scale_form</STRONG> returns the minimum size  required
79        for the subwindow of <EM>form</EM>.
80
81
82 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></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><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
104        <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>.
105
106
107 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
108        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
109        file <STRONG>&lt;curses.h&gt;</STRONG>.
110
111
112 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
113        These  routines  emulate the System V forms library.  They
114        were not supported on Version 7 or BSD versions.
115
116
117 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
118        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
119        curses by Eric S. Raymond.
120
121
122
123                                                            <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
124 </PRE>
125 <div class="nav">
126 <ul>
127 <li><a href="#h2-NAME">NAME</a></li>
128 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
129 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
130 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
131 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
132 <li><a href="#h2-NOTES">NOTES</a></li>
133 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
134 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
135 </ul>
136 </div>
137 </BODY>
138 </HTML>