summaryrefslogtreecommitdiffstats
path: root/ncurses-5.2/doc/html/man/form_win.3x.html
blob: 4f73a6410cf59abdbdab1f28c3ab2a4757cf44a7 (plain) (blame)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
<HTML>
<BODY>
<PRE>
<!-- Manpage converted by man2html 3.0.1 -->

</PRE>
<H2>NAME</H2><PRE>
       <B>form_win</B>  - make and break form window and subwindow asso-
       ciations


</PRE>
<H2>SYNOPSIS</H2><PRE>
       <B>#include</B> <B>&lt;form.h&gt;</B>
       int set_form_win(FORM *form, WINDOW *win);
       WINDOW *form_win(const FORM *form);
       int set_form_sub(FORM *form, WINDOW *sub);
       WINDOW *form_sub(const FORM *form);
       int scale_form(const FORM *form, int *rows, int *columns);


</PRE>
<H2>DESCRIPTION</H2><PRE>
       Every  form has an associated pair of <B>curses</B> windows.  The
       form window displays any title and border associated  with
       the  window;  the form subwindow displays the items of the
       form that are currently available for selection.

       The first four functions get and set those windows.  It is
       not necessary to set either window; by default, the driver
       code uses <B>stdscr</B> for both.

       In the <B>set_</B> functions, window argument of <B>NULL</B> is  treated
       as  though  it  were  <B>stsdcr</B>.   A form argument of <B>NULL</B> is
       treated as a request to change  the  system  default  form
       window or subwindow.

       The  function <B>scale_form</B> returns the minimum size required
       for the subwindow of <I>form</I>.


</PRE>
<H2>RETURN VALUE</H2><PRE>
       Routines that return pointers return <B>NULL</B> on error.   Rou-
       tines  that  return an integer return one of the following
       error codes:

       <B>E_OK</B> The routine succeeded.

       <B>E_SYSTEM_ERROR</B>
            System error occurred (see <B>errno</B>).

       <B>E_BAD_ARGUMENT</B>
            Routine detected an incorrect or  out-of-range  argu-
            ment.

       <B>E_POSTED</B>
            The form has already been posted.

       <B>E_NOT_CONNECTED</B>
            No items are connected to the form.


</PRE>
<H2>SEE ALSO</H2><PRE>
       <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="form.3x.html">form(3x)</A></B>.



</PRE>
<H2>NOTES</H2><PRE>
       The header file <B>&lt;form.h&gt;</B> automatically includes the header
       file <B>&lt;curses.h&gt;</B>.


</PRE>
<H2>PORTABILITY</H2><PRE>
       These routines emulate the System V forms  library.   They
       were not supported on Version 7 or BSD versions.


</PRE>
<H2>AUTHORS</H2><PRE>
       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
       curses by Eric S. Raymond.











































</PRE>
<HR>
<ADDRESS>
Man(1) output converted with
<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
</ADDRESS>
</BODY>
</HTML>