ncurses 6.0 - patch 20161029
[ncurses.git] / man / form_page.3x
index 2211216d81554b2e50db9d8e893187f4d654ea9b..ad3dc883091541dc97ced242698b3636f7426806 100644 (file)
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
-.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
+.\" Copyright (c) 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            *
@@ -27,7 +27,7 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
-.\" $Id: form_page.3x,v 1.12 2010/12/04 18:40:45 tom Exp $
+.\" $Id: form_page.3x,v 1.14 2016/10/29 22:27:24 tom Exp $
 .TH form_page 3X ""
 .SH NAME
 \fBform_page\fR \- set and get form page number
@@ -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,9 +47,13 @@ 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
@@ -85,6 +91,8 @@ The header file \fB<form.h>\fR automatically includes the header file
 .SH PORTABILITY
 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.