+<!--
+ * t
+ ****************************************************************************
+ * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 1998-2006,2010 Free Software Foundation, Inc. *
+ * *
+ * Permission is hereby granted, free of charge, to any person obtaining a *
+ * copy of this software and associated documentation files (the *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @Id: form_win.3x,v 1.18 2020/10/18 00:00:32 tom Exp @
+-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
+<HEAD>
+<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
+<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
+<TITLE>form_win 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<H1 class="no-header">form_win 3X</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
+<B><A HREF="form_win.3X.html">form_win(3X)</A></B> <B><A HREF="form_win.3X.html">form_win(3X)</A></B>
-</PRE>
-<H2>NAME</H2><PRE>
- <B>form_win</B> - make and break form window and subwindow asso-
- ciations
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
+
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <B>form_win</B> - make and break form window and subwindow associations
+
+
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
<B>#include</B> <B><form.h></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);
+ <B>int</B> <B>set_form_win(FORM</B> <B>*</B><I>form</I><B>,</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
+ <B>WINDOW</B> <B>*form_win(const</B> <B>FORM</B> <B>*</B><I>form</I><B>);</B>
-</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.
+ <B>int</B> <B>set_form_sub(FORM</B> <B>*</B><I>form</I><B>,</B> <B>WINDOW</B> <B>*</B><I>sub</I><B>);</B>
+ <B>WINDOW</B> <B>*form_sub(const</B> <B>FORM</B> <B>*</B><I>form</I><B>);</B>
- 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.
+ <B>int</B> <B>scale_form(const</B> <B>FORM</B> <B>*</B><I>form</I><B>,</B> <B>int</B> <B>*</B><I>rows</I><B>,</B> <B>int</B> <B>*</B><I>columns</I><B>);</B>
- 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><a name="h2-DESCRIPTION">DESCRIPTION</a></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.
-</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:
+ 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><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ Routines that return pointers return <B>NULL</B> on error. Routines 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>).
+ System error occurred (see <B>errno(3)</B>).
<B>E_BAD_ARGUMENT</B>
- Routine detected an incorrect or out-of-range argu-
- ment.
+ Routine detected an incorrect or out-of-range argument.
<B>E_POSTED</B>
The form has already been posted.
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><form.h></B> automatically includes the header
- file <B><curses.h></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><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>, <B><A HREF="form.3X.html">form(3X)</A></B>.
+</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
+ The header file <B><form.h></B> automatically includes the header file
+ <B><curses.h></B>.
+</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
+ These routines emulate the System V forms library. They were not
+ supported on Version 7 or BSD versions.
+</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
+ Raymond.
+ <B><A HREF="form_win.3X.html">form_win(3X)</A></B>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<div class="nav">
+<ul>
+<li><a href="#h2-NAME">NAME</a></li>
+<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
+<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
+<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
+<li><a href="#h2-NOTES">NOTES</a></li>
+<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
+<li><a href="#h2-AUTHORS">AUTHORS</a></li>
+</ul>
+</div>
</BODY>
</HTML>
projects / ncurses.git / blobdiff