ncurses 6.1 - patch 20180728

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

diff --git a/man/form_page.3x b/man/form_page.3x
index 50ed54db4cc5e5898f1fb5c1bb75a4799054a35e..76159e2bf8ab123a53b121a97fdf2268317660bc 100644 (file)
--- a/man/form_page.3x
+++ b/man/form_page.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998,2006 Free Software Foundation, Inc.                   *
+.\" Copyright (c) 1998-2016,2018 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            *
@@ -27,10 +27,10 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form_page.3x,v 1.10 2006/11/04 18:52:32 tom Exp $
+.\" $Id: form_page.3x,v 1.15 2018/07/28 21:34:06 tom Exp $
 .TH form_page 3X ""
 .SH NAME
-\fBform_page\fR - set and get form page number
+\fBform_page\fR \- set and get form page number
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br
@@ -38,6 +38,8 @@ int set_current_field(FORM *form, FIELD *field);
 .br
 FIELD *current_field(const FORM *);
 .br
+int unfocus_current_field(FORM *form);
+.br
 int set_form_page(FORM *form, int n);
 .br
 int form_page(const FORM *form);
@@ -45,16 +47,21 @@ int form_page(const FORM *form);
 int field_index(const FIELD *field);
 .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
+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
-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:
@@ -83,14 +90,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
-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.
+.PP
+The \fBunfocus_current_field\fP function is an ncurses extension.
 .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.