<!--
- * t
****************************************************************************
- * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 2018-2023,2024 Thomas E. Dickey *
* Copyright 1998-2006,2010 Free Software Foundation, Inc. *
* *
* Permission is hereby granted, free of charge, to any person obtaining a *
* 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 @
+ * @Id: form_win.3x,v 1.35 2024/03/16 15:35:01 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>
+<TITLE>form_win 3x 2024-03-16 ncurses 6.4 Library calls</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>
+<H1 class="no-header">form_win 3x 2024-03-16 ncurses 6.4 Library calls</H1>
<PRE>
-<B><A HREF="form_win.3X.html">form_win(3X)</A></B> <B><A HREF="form_win.3X.html">form_win(3X)</A></B>
+<STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG> Library calls <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <B>form_win</B> - make and break form window and subwindow associations
+ <STRONG>form_win</STRONG> - 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>
+ <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
- <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>
+ <STRONG>int</STRONG> <STRONG>set_form_win(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
+ <STRONG>WINDOW</STRONG> <STRONG>*form_win(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
- <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>
+ <STRONG>int</STRONG> <STRONG>set_form_sub(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>sub</EM><STRONG>);</STRONG>
+ <STRONG>WINDOW</STRONG> <STRONG>*form_sub(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
- <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>
+ <STRONG>int</STRONG> <STRONG>scale_form(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>rows</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>columns</EM><STRONG>);</STRONG>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- Every form has an associated pair of <B>curses</B> windows. The form window
+ 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 <B>stdscr</B>
+ necessary to set either window; by default, the driver code uses <STRONG>stdscr</STRONG>
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
+ 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.
- The function <B>scale_form</B> returns the minimum size required for the
- subwindow of <I>form</I>.
+ The function <STRONG>scale_form</STRONG> returns the minimum size required for the
+ subwindow of <EM>form</EM>.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- Routines that return pointers return <B>NULL</B> on error. Routines that
+ Routines that return pointers return <STRONG>NULL</STRONG> on error. Routines that
return an integer return one of the following error codes:
- <B>E_OK</B> The routine succeeded.
+ <STRONG>E_OK</STRONG> The routine succeeded.
- <B>E_SYSTEM_ERROR</B>
- System error occurred (see <B>errno(3)</B>).
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno(3)</STRONG>).
- <B>E_BAD_ARGUMENT</B>
+ <STRONG>E_BAD_ARGUMENT</STRONG>
Routine detected an incorrect or out-of-range argument.
- <B>E_POSTED</B>
+ <STRONG>E_POSTED</STRONG>
The form has already been posted.
- <B>E_NOT_CONNECTED</B>
+ <STRONG>E_NOT_CONNECTED</STRONG>
No items are connected to the form.
-</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
+ These routines emulate the System V forms library. They were not
supported on Version 7 or BSD versions.
Raymond.
+</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
+ <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>
+
+
- <B><A HREF="form_win.3X.html">form_win(3X)</A></B>
+ncurses 6.4 2024-03-16 <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
</PRE>
<div class="nav">
<ul>
<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>
+<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
</ul>
</div>
</BODY>
projects / ncurses.git / blobdiff