ncurses 6.2 - patch 20201205

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

diff --git a/man/form_page.3x b/man/form_page.3x
index 385ca21de51ef9c02d0884b12ef91a895c713de6..da1c7254b6467728d54481f52555c19a7aaef1e5 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-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            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -27,34 +28,41 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: form_page.3x,v 1.11 2010/07/31 16:08:48 tom Exp $
+.\" $Id: form_page.3x,v 1.19 2020/10/18 00:02:44 tom Exp $

 .TH form_page 3X ""
 .SH NAME
 \fBform_page\fR \- set and get form page number
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .TH form_page 3X ""
 .SH NAME
 \fBform_page\fR \- set and get form page number
 .SH SYNOPSIS
 \fB#include <form.h>\fR

+.sp
+\fBint set_current_field(FORM *\fP\fIform\fP\fB, FIELD *\fP\fIfield\fP\fB);\fP

 .br
 .br

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

 .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 *\fP\fIform\fP\fB);\fP
+.sp
+\fBint field_index(const FIELD *\fP\fIfield\fP\fB);\fP

 .br
 .SH DESCRIPTION
 .br
 .SH DESCRIPTION

-The function \fBset_current field\fR sets the current field of the given
+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.
 .PP
 form; \fBcurrent_field\fR returns the current field of the given form.
 .PP

+The function \fBunfocus_current_field\fR removes the focus from the current
+field of the form.
+In such state, inquiries via \fBcurrent_field\fR shall return a NULL pointer.
+.PP

 The function \fBset_form_page\fR sets the form's page number (goes to page
 \fIn\fR of the form).
 .PP
 The function \fBform_page\fR returns the form's current page number.
 .PP
 The function \fBfield_index\fR returns the index of the field in the
 The function \fBset_form_page\fR sets the form's page number (goes to page
 \fIn\fR of the form).
 .PP
 The function \fBform_page\fR returns the form's current page number.
 .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
+field array of the form it is connected to.
+It returns \fBERR\fR if

 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:
 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:


@@ -75,7 +83,7 @@ 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\fR(3)).

 .
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBform\fR(3X).
 .
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBform\fR(3X).


@@ -83,14 +91,11 @@ System error occurred (see \fBerrno\fR).
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
 .SH PORTABILITY
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
 .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.