summaryrefslogtreecommitdiff
path: root/ncurses-5.2/doc/html/man/form_win.3x.html
diff options
context:
space:
mode:
Diffstat (limited to 'ncurses-5.2/doc/html/man/form_win.3x.html')
-rw-r--r--ncurses-5.2/doc/html/man/form_win.3x.html136
1 files changed, 136 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/form_win.3x.html b/ncurses-5.2/doc/html/man/form_win.3x.html
new file mode 100644
index 0000000..4f73a64
--- /dev/null
+++ b/ncurses-5.2/doc/html/man/form_win.3x.html
@@ -0,0 +1,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>