1<!-- 2 **************************************************************************** 3 * Copyright 2018-2023,2024 Thomas E. Dickey * 4 * Copyright 1998-2006,2010 Free Software Foundation, Inc. * 5 * * 6 * Permission is hereby granted, free of charge, to any person obtaining a * 7 * copy of this software and associated documentation files (the * 8 * "Software"), to deal in the Software without restriction, including * 9 * without limitation the rights to use, copy, modify, merge, publish, * 10 * distribute, distribute with modifications, sublicense, and/or sell * 11 * copies of the Software, and to permit persons to whom the Software is * 12 * furnished to do so, subject to the following conditions: * 13 * * 14 * The above copyright notice and this permission notice shall be included * 15 * in all copies or substantial portions of the Software. * 16 * * 17 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * 18 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * 19 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * 20 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * 21 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * 22 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * 23 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. * 24 * * 25 * Except as contained in this notice, the name(s) of the above copyright * 26 * holders shall not be used in advertising or otherwise to promote the * 27 * sale, use or other dealings in this Software without prior written * 28 * authorization. * 29 **************************************************************************** 30 * @Id: form_win.3x,v 1.35 2024/03/16 15:35:01 tom Exp @ 31--> 32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> 33<HTML> 34<HEAD> 35<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> 36<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> 37<TITLE>form_win 3x 2024-03-16 ncurses 6.5 Library calls</TITLE> 38<link rel="author" href="mailto:bug-ncurses@gnu.org"> 39 40</HEAD> 41<BODY> 42<H1 class="no-header">form_win 3x 2024-03-16 ncurses 6.5 Library calls</H1> 43<PRE> 44<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> 45 46 47 48 49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 50 <STRONG>form_win</STRONG> - make and break form window and subwindow associations 51 52 53</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 54 <STRONG>#include</STRONG> <STRONG><form.h></STRONG> 55 56 <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> 57 <STRONG>WINDOW</STRONG> <STRONG>*form_win(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG> 58 59 <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> 60 <STRONG>WINDOW</STRONG> <STRONG>*form_sub(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG> 61 62 <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> 63 64 65</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 66 Every form has an associated pair of <STRONG>curses</STRONG> windows. The form window 67 displays any title and border associated with the window; the form 68 subwindow displays the items of the form that are currently available 69 for selection. 70 71 The first four functions get and set those windows. It is not 72 necessary to set either window; by default, the driver code uses <STRONG>stdscr</STRONG> 73 for both. 74 75 In the <STRONG>set_</STRONG> functions, window argument of <STRONG>NULL</STRONG> is treated as though it 76 were <STRONG>stsdcr</STRONG>. A form argument of <STRONG>NULL</STRONG> is treated as a request to change 77 the system default form window or subwindow. 78 79 The function <STRONG>scale_form</STRONG> returns the minimum size required for the 80 subwindow of <EM>form</EM>. 81 82 83</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 84 Routines that return pointers return <STRONG>NULL</STRONG> on error. Routines that 85 return an integer return one of the following error codes: 86 87 <STRONG>E_OK</STRONG> The routine succeeded. 88 89 <STRONG>E_SYSTEM_ERROR</STRONG> 90 System error occurred (see <STRONG>errno(3)</STRONG>). 91 92 <STRONG>E_BAD_ARGUMENT</STRONG> 93 Routine detected an incorrect or out-of-range argument. 94 95 <STRONG>E_POSTED</STRONG> 96 The form has already been posted. 97 98 <STRONG>E_NOT_CONNECTED</STRONG> 99 No items are connected to the form. 100 101 102</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 103 These routines emulate the System V forms library. They were not 104 supported on Version 7 or BSD versions. 105 106 107</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> 108 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. 109 Raymond. 110 111 112</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 113 <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> 114 115 116 117ncurses 6.5 2024-03-16 <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG> 118</PRE> 119<div class="nav"> 120<ul> 121<li><a href="#h2-NAME">NAME</a></li> 122<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 123<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 124<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 125<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 126<li><a href="#h2-AUTHORS">AUTHORS</a></li> 127<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 128</ul> 129</div> 130</BODY> 131</HTML> 132