X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_page.3x;h=3e10402c5f87349afb3dc8e4be4c568fb6c6c5a9;hp=4b5d15aec18e45f42349fd8b85926956ec3da301;hb=6b4f5830b7910188b532d661f79775306715f67e;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/form_page.3x b/man/form_page.3x index 4b5d15ae..3e10402c 100644 --- a/man/form_page.3x +++ b/man/form_page.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 1998-2018,2019 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.8 1998/11/29 01:08:02 Rick.Ohnemus Exp $ +.\" $Id: form_page.3x,v 1.16 2019/01/20 20:31:42 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 \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,51 +47,54 @@ 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: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). -.TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .TP 5 -\fBE_BAD_STATE\fR +.B E_BAD_STATE Routine was called from an initialization or termination function. .TP 5 -\fBE_INVALID_FIELD\fR +.B E_INVALID_FIELD Contents of a field are not valid. .TP 5 -\fBE_REQUEST_DENIED\fR +.B E_REQUEST_DENIED The form driver could not process the request. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR(3)). +. .SH SEE ALSO \fBcurses\fR(3X), \fBform\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header file \fB\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.