ncurses 6.3 - patch 20220827

[ncurses.git] / man / form_page.3x

diff --git a/man/form_page.3x b/man/form_page.3x
index 385ca21de51ef9c02d0884b12ef91a895c713de6..5205859ee4098e246e8fc718a70018f60a1ab121 100644 (file)
--- a/man/form_page.3x
+++ b/man/form_page.3x
@@ -1,6 +1,7 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
+.\" Copyright 2018-2021,2022 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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -27,37 +28,44 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: form_page.3x,v 1.11 2010/07/31 16:08:48 tom Exp $
+.\" $Id: form_page.3x,v 1.22 2022/02/12 20:03:40 tom Exp $

 .TH form_page 3X ""
 .SH NAME
 .TH form_page 3X ""
 .SH NAME

-\fBform_page\fR \- set and get form page number
+\fBform_page\fP \- set and get form page number

 .SH SYNOPSIS
 .SH SYNOPSIS

-\fB#include <form.h>\fR
+\fB#include <form.h>\fP
+.sp
+\fBint set_current_field(FORM *\fIform\fB, FIELD *\fIfield\fB);\fR

 .br
 .br

-int set_current_field(FORM *form, FIELD *field);
+\fBFIELD *current_field(const FORM *\fIform\fB);\fR
+.sp
+\fBint unfocus_current_field(FORM *\fIform\fB);\fR
+.sp
+\fBint set_form_page(FORM *\fIform\fB, int \fIn\fB);\fR

 .br
 .br

-FIELD *current_field(const FORM *);
-.br
-int set_form_page(FORM *form, int n);
-.br
-int form_page(const FORM *form);
-.br
-int field_index(const FIELD *field);
+\fBint form_page(const FORM *\fIform\fB);\fR
+.sp
+\fBint field_index(const FIELD *\fIfield\fB);\fR

 .br
 .SH DESCRIPTION
 .br
 .SH DESCRIPTION

-The function \fBset_current field\fR sets the current field of the given
-form; \fBcurrent_field\fR returns the current field of the given form.
+The function \fBset_current_field\fP sets the current field of the given
+form; \fBcurrent_field\fP returns the current field of the given form.

 .PP
 .PP

-The function \fBset_form_page\fR sets the form's page number (goes to page
-\fIn\fR of the form).
+The function \fBunfocus_current_field\fP removes the focus from the current
+field of the form.
+In such state, inquiries via \fBcurrent_field\fP shall return a NULL pointer.

 .PP
 .PP

-The function \fBform_page\fR returns the form's current page number.
+The function \fBset_form_page\fP sets the form's page number (goes to page
+\fIn\fP of the form).

 .PP
 .PP

-The function \fBfield_index\fR returns the index of the field in the
-field array of the form it is connected to. It returns \fBERR\fR if
+The function \fBform_page\fP returns the form's current page number.
+.PP
+The function \fBfield_index\fP returns the index of the field in the
+field array of the form it is connected to.
+It returns \fBERR\fP if

 the argument is the null pointer or the field is not connected.
 .SH RETURN VALUE
 the argument is the null pointer or the field is not connected.
 .SH RETURN VALUE

-Except for \fBform_page\fR, each routine returns one of the following:
+Except for \fBform_page\fP, each routine returns one of the following:

 .TP 5
 .B E_OK
 The routine succeeded.
 .TP 5
 .B E_OK
 The routine succeeded.


@@ -75,22 +83,19 @@ Contents of a field are not valid.
 The form driver could not process the request.
 .TP 5
 .B E_SYSTEM_ERROR
 The form driver could not process the request.
 .TP 5
 .B E_SYSTEM_ERROR

-System error occurred (see \fBerrno\fR).
+System error occurred (see \fBerrno\fP(3)).

 .
 .SH SEE ALSO
 .
 .SH SEE ALSO

-\fBcurses\fR(3X), \fBform\fR(3X).
+\fBcurses\fP(3X), \fBform\fP(3X).

 .SH NOTES
 .SH NOTES

-The header file \fB<form.h>\fR automatically includes the header file
-\fB<curses.h>\fR.
+The header file \fB<form.h>\fP automatically includes the header file
+\fB<curses.h>\fP.

 .SH PORTABILITY
 .SH PORTABILITY

-These routines emulate the System V forms library.  They were not supported on
+These routines emulate the System V forms library.
+They were not supported on

 Version 7 or BSD versions.
 Version 7 or BSD versions.

+.PP
+The \fBunfocus_current_field\fP function is an ncurses extension.

 .SH AUTHORS
 .SH AUTHORS

-Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
-S. Raymond.
-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End:
+Juergen Pfeifer.
+Manual pages and adaptation for new curses by Eric S. Raymond.