-<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
-<!--
+<!--
* t
****************************************************************************
- * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
+ * Copyright 2018-2019,2020 Thomas E. Dickey *
+ * Copyright 1998-2010,2016 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_page.3x,v 1.12 2010/12/04 18:40:45 tom Exp @
+ * @Id: form_page.3x,v 1.19 2020/10/18 00:02:44 tom Exp @
-->
+<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
-<TITLE>form_page 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<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_page 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>form_page 3x</H1>
-<HR>
+<H1 class="no-header">form_page 3X</H1>
<PRE>
-<!-- Manpage converted by man2html 3.0.1 -->
-<STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG> <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
+<B><A HREF="form_page.3X.html">form_page(3X)</A></B> <B><A HREF="form_page.3X.html">form_page(3X)</A></B>
-</PRE>
-<H2>NAME</H2><PRE>
- <STRONG>form_page</STRONG> - set and get form page number
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <B>form_page</B> - set and get form page number
-</PRE>
-<H2>SYNOPSIS</H2><PRE>
- <STRONG>#include</STRONG> <STRONG><form.h></STRONG>
- int set_current_field(FORM *form, FIELD *field);
- FIELD *current_field(const FORM *);
- int set_form_page(FORM *form, int n);
- int form_page(const FORM *form);
- int field_index(const FIELD *field);
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+ <B>#include</B> <B><form.h></B>
+ <B>int</B> <B>set_current_field(FORM</B> <B>*</B><I>form</I><B>,</B> <B>FIELD</B> <B>*</B><I>field</I><B>);</B>
+ <B>FIELD</B> <B>*current_field(const</B> <B>FORM</B> <B>*</B><I>form</I><B>);</B>
-</PRE>
-<H2>DESCRIPTION</H2><PRE>
- The function <STRONG>set_current</STRONG> <STRONG>field</STRONG> sets the current field of
- the given form; <STRONG>current_field</STRONG> returns the current field of
- the given form.
+ <B>int</B> <B>unfocus_current_field(FORM</B> <B>*</B><I>form</I><B>);</B>
- The function <STRONG>set_form_page</STRONG> sets the form's page number
- (goes to page <EM>n</EM> of the form).
+ <B>int</B> <B>set_form_page(FORM</B> <B>*</B><I>form</I><B>,</B> <B>int</B> <I>n</I><B>);</B>
+ <B>int</B> <B>form_page(const</B> <B>FORM</B> <B>*</B><I>form</I><B>);</B>
- The function <STRONG>form_page</STRONG> returns the form's current page
- number.
+ <B>int</B> <B>field_index(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>);</B>
- The function <STRONG>field_index</STRONG> returns the index of the field in
- the field array of the form it is connected to. It returns
- <STRONG>ERR</STRONG> if the argument is the null pointer or the field is
- not connected.
+</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
+ The function <B>set_current_field</B> sets the current field of the given
+ form; <B>current_field</B> returns the current field of the given form.
-</PRE>
-<H2>RETURN VALUE</H2><PRE>
- Except for <STRONG>form_page</STRONG>, each routine returns one of the fol-
- lowing:
+ The function <B>unfocus_current_field</B> removes the focus from the current
+ field of the form. In such state, inquiries via <B>current_field</B> shall
+ return a NULL pointer.
+
+ The function <B>set_form_page</B> sets the form's page number (goes to page <I>n</I>
+ of the form).
+
+ The function <B>form_page</B> returns the form's current page number.
- <STRONG>E_OK</STRONG> The routine succeeded.
+ The function <B>field_index</B> returns the index of the field in the field
+ array of the form it is connected to. It returns <B>ERR</B> if the argument
+ is the null pointer or the field is not connected.
- <STRONG>E_BAD_ARGUMENT</STRONG>
- Routine detected an incorrect or out-of-range argu-
- ment.
- <STRONG>E_BAD_STATE</STRONG>
- Routine was called from an initialization or termina-
- tion function.
+</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
+ Except for <B>form_page</B>, each routine returns one of the following:
- <STRONG>E_INVALID_FIELD</STRONG>
+ <B>E_OK</B> The routine succeeded.
+
+ <B>E_BAD_ARGUMENT</B>
+ Routine detected an incorrect or out-of-range argument.
+
+ <B>E_BAD_STATE</B>
+ Routine was called from an initialization or termination function.
+
+ <B>E_INVALID_FIELD</B>
Contents of a field are not valid.
- <STRONG>E_REQUEST_DENIED</STRONG>
+ <B>E_REQUEST_DENIED</B>
The form driver could not process the request.
- <STRONG>E_SYSTEM_ERROR</STRONG>
- System error occurred (see <STRONG>errno</STRONG>).
+ <B>E_SYSTEM_ERROR</B>
+ System error occurred (see <B>errno(3)</B>).
-</PRE>
-<H2>SEE ALSO</H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
+</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="form.3X.html">form(3X)</A></B>.
-</PRE>
-<H2>NOTES</H2><PRE>
- The header file <STRONG><form.h></STRONG> automatically includes the header
- file <STRONG><curses.h></STRONG>.
+</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>PORTABILITY</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-PORTABILITY">PORTABILITY</a></H2><PRE>
+ These routines emulate the System V forms library. They were not
+ supported on Version 7 or BSD versions.
+ The <B>unfocus_current_field</B> function is an ncurses extension.
-</PRE>
- Juergen Pfeifer. Manual pages and adaptation for new
- curses by Eric S. Raymond.
+
+<
/PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
+ Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
+ Raymond.
- <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
+ <B><A HREF="form_page.3X.html">form_page(3X)</A></B>
</PRE>
-<HR>
-Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a>
+<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