X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fform_page.3x;h=da1c7254b6467728d54481f52555c19a7aaef1e5;hp=ad3dc883091541dc97ced242698b3636f7426806;hb=fae162795e065e5901068152e91f2962b6b247f3;hpb=9c110809dcc6246cb01544e9cb6c709795697a1a;ds=sidebyside diff --git a/man/form_page.3x b/man/form_page.3x index ad3dc883..da1c7254 100644 --- a/man/form_page.3x +++ b/man/form_page.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2010,2016 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 * @@ -27,32 +28,32 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_page.3x,v 1.14 2016/10/29 22:27:24 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 \fR +.sp +\fBint set_current_field(FORM *\fP\fIform\fP\fB, FIELD *\fP\fIfield\fP\fB);\fP .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 -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); -.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 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. +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). @@ -60,7 +61,8 @@ The function \fBset_form_page\fR sets the form's page number (goes to page 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: @@ -81,7 +83,7 @@ Contents of a field are not valid. 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). @@ -89,10 +91,11 @@ System error occurred (see \fBerrno\fR). 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. +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.