1<!-- 2 **************************************************************************** 3 * Copyright 2018-2023,2024 Thomas E. Dickey * 4 * Copyright 1998-2010,2016 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_page.3x,v 1.37 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_page 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_page 3x 2024-03-16 ncurses 6.5 Library calls</H1> 43<PRE> 44<STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> Library calls <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> 45 46 47 48 49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 50 <STRONG>form_page</STRONG> - set and get form page number 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_current_field(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG> 57 <STRONG>FIELD</STRONG> <STRONG>*current_field(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG> 58 59 <STRONG>int</STRONG> <STRONG>unfocus_current_field(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG> 60 61 <STRONG>int</STRONG> <STRONG>set_form_page(FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>n</EM><STRONG>);</STRONG> 62 <STRONG>int</STRONG> <STRONG>form_page(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG> 63 64 <STRONG>int</STRONG> <STRONG>field_index(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG> 65 66 67</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 68 The function <STRONG>set_current_field</STRONG> sets the current field of the given 69 form; <STRONG>current_field</STRONG> returns the current field of the given form. 70 71 The function <STRONG>unfocus_current_field</STRONG> removes the focus from the current 72 field of the form. In such state, inquiries via <STRONG>current_field</STRONG> shall 73 return a NULL pointer. 74 75 The function <STRONG>set_form_page</STRONG> sets the form's page number (goes to page <EM>n</EM> 76 of the form). 77 78 The function <STRONG>form_page</STRONG> returns the form's current page number. 79 80 The function <STRONG>field_index</STRONG> returns the index of the field in the field 81 array of the form it is connected to. It returns <STRONG>ERR</STRONG> if the argument 82 is the null pointer or the field is not connected. 83 84 85</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 86 Except for <STRONG>form_page</STRONG>, each routine returns one of the following: 87 88 <STRONG>E_OK</STRONG> The routine succeeded. 89 90 <STRONG>E_BAD_ARGUMENT</STRONG> 91 Routine detected an incorrect or out-of-range argument. 92 93 <STRONG>E_BAD_STATE</STRONG> 94 Routine was called from an initialization or termination function. 95 96 <STRONG>E_INVALID_FIELD</STRONG> 97 Contents of a field are not valid. 98 99 <STRONG>E_REQUEST_DENIED</STRONG> 100 The form driver could not process the request. 101 102 <STRONG>E_SYSTEM_ERROR</STRONG> 103 System error occurred (see <STRONG>errno(3)</STRONG>). 104 105 106</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 107 These routines emulate the System V forms library. They were not 108 supported on Version 7 or BSD versions. 109 110 The <STRONG>unfocus_current_field</STRONG> function is an <EM>ncurses</EM> extension. 111 112 113</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> 114 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. 115 Raymond. 116 117 118</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 119 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG> 120 121 122 123ncurses 6.5 2024-03-16 <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> 124</PRE> 125<div class="nav"> 126<ul> 127<li><a href="#h2-NAME">NAME</a></li> 128<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 129<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 130<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 131<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 132<li><a href="#h2-AUTHORS">AUTHORS</a></li> 133<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 134</ul> 135</div> 136</BODY> 137</HTML> 138