X-Git-Url: http://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_page.3x;h=5205859ee4098e246e8fc718a70018f60a1ab121;hb=414771292d2331e48bc09f49813998adc33929e2;hp=76159e2bf8ab123a53b121a97fdf2268317660bc;hpb=17c5992a16be94247b83f2bbb9accdd9b7e7bb72;p=ncurses.git diff --git a/man/form_page.3x b/man/form_page.3x index 76159e2b..5205859e 100644 --- a/man/form_page.3x +++ b/man/form_page.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2016,2018 Free Software Foundation, Inc. * +.\" Copyright 2018-2021,2022 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,44 +28,44 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_page.3x,v 1.15 2018/07/28 21:34:06 tom Exp $ +.\" $Id: form_page.3x,v 1.22 2022/02/12 20:03:40 tom Exp $ .TH form_page 3X "" .SH NAME -\fBform_page\fR \- set and get form page number +\fBform_page\fP \- set and get form page number .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_current_field(FORM *\fIform\fB, FIELD *\fIfield\fB);\fR .br -int set_current_field(FORM *form, FIELD *field); +\fBFIELD *current_field(const FORM *\fIform\fB);\fR +.sp +\fBint unfocus_current_field(FORM *\fIform\fB);\fR +.sp +\fBint set_form_page(FORM *\fIform\fB, int \fIn\fB);\fR .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 *\fIform\fB);\fR +.sp +\fBint field_index(const FIELD *\fIfield\fB);\fR .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. +The function \fBset_current_field\fP sets the current field of the given +form; \fBcurrent_field\fP returns the current field of the given form. .PP -The function \fBunfocus_current_field\fR removes the focus from the current +The function \fBunfocus_current_field\fP removes the focus from the current field of the form. -In such state, inquiries via \fBcurrent_field\fR shall return a NULL pointer. +In such state, inquiries via \fBcurrent_field\fP 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). +The function \fBset_form_page\fP sets the form's page number (goes to page +\fIn\fP of the form). .PP -The function \fBform_page\fR returns the form's current page number. +The function \fBform_page\fP returns the form's current page number. .PP -The function \fBfield_index\fR returns the index of the field in the +The function \fBfield_index\fP returns the index of the field in the field array of the form it is connected to. -It returns \fBERR\fR if +It returns \fBERR\fP 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: +Except for \fBform_page\fP, each routine returns one of the following: .TP 5 .B E_OK The routine succeeded. @@ -82,13 +83,13 @@ 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\fP(3)). . .SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). +\fBcurses\fP(3X), \fBform\fP(3X). .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .SH PORTABILITY These routines emulate the System V forms library. They were not supported on