1997-05-15 12:00:00 +08:00
|
|
|
<HTML>
|
1999-10-24 12:32:42 +08:00
|
|
|
<BODY>
|
1997-05-15 12:00:00 +08:00
|
|
|
<PRE>
|
|
|
|
|
<STRONG>form_win</STRONG> - make and break form window and subwindow asso-
|
|
|
|
|
ciations
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>SYNOPSIS</H2><PRE>
|
1999-10-24 12:32:42 +08:00
|
|
|
<STRONG>#include</STRONG> <STRONG><form.h></STRONG>
|
1997-05-15 12:00:00 +08:00
|
|
|
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 <STRONG>curses</STRONG> 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 <STRONG>stdscr</STRONG> for both.
|
|
|
|
|
|
|
|
|
|
In the <STRONG>set_</STRONG> functions, window argument of <STRONG>NULL</STRONG> is treated
|
|
|
|
|
as though it were <STRONG>stsdcr</STRONG>. A form argument of <STRONG>NULL</STRONG> is
|
|
|
|
|
treated as a request to change the system default form
|
|
|
|
|
window or subwindow.
|
|
|
|
|
|
1999-10-24 12:32:42 +08:00
|
|
|
The function <STRONG>scale_form</STRONG> returns the minimum size required
|
|
|
|
|
for the subwindow of <EM>form</EM>.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>RETURN VALUE</H2><PRE>
|
|
|
|
|
Routines that return pointers return <STRONG>NULL</STRONG> on error. Rou-
|
|
|
|
|
tines that return an integer return one of the following
|
|
|
|
|
error codes:
|
|
|
|
|
|
|
|
|
|
<STRONG>E_OK</STRONG> The routine succeeded.
|
|
|
|
|
|
|
|
|
|
<STRONG>E_SYSTEM_ERROR</STRONG>
|
|
|
|
|
System error occurred (see <STRONG>errno</STRONG>).
|
|
|
|
|
|
|
|
|
|
<STRONG>E_BAD_ARGUMENT</STRONG>
|
|
|
|
|
Routine detected an incorrect or out-of-range argu-
|
|
|
|
|
ment.
|
|
|
|
|
|
|
|
|
|
<STRONG>E_POSTED</STRONG>
|
|
|
|
|
The form has already been posted.
|
|
|
|
|
|
|
|
|
|
<STRONG>E_NOT_CONNECTED</STRONG>
|
|
|
|
|
No items are connected to the form.
|
|
|
|
|
|
|
|
|
|
|
|
|
|
|
</PRE>
|
|
|
|
|
<H2>SEE ALSO</H2><PRE>
|
|
|
|
|
<STRONG><A HREF="ncurses.3x.html">curses(3X)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3X)</A></STRONG>.
|
|
|
|
|
|
1999-10-24 12:32:42 +08:00
|
|
|
The header file <STRONG><form.h></STRONG> automatically includes the header
|
|
|
|
|
file <STRONG><curses.h></STRONG>.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
|
|
|
|
|
</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>
|
|
|
|
|
</BODY>
|
|
|
|
|
</HTML>
|
