X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_page.3x;h=fa538c620143a7a27146fc66b5b5dd00119a6a0f;hb=75a9c36c205ebefe07580acd0b1053a2abbd44b9;hp=da1c7254b6467728d54481f52555c19a7aaef1e5;hpb=e5d1530ca229aef94a3c84ad33f8ae89f35c4045;p=ncurses.git diff --git a/man/form_page.3x b/man/form_page.3x index da1c7254..fa538c62 100644 --- a/man/form_page.3x +++ b/man/form_page.3x @@ -1,6 +1,5 @@ -'\" t .\"*************************************************************************** -.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 2018-2023,2024 Thomas E. Dickey * .\" Copyright 1998-2010,2016 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * @@ -28,44 +27,44 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_page.3x,v 1.19 2020/10/18 00:02:44 tom Exp $ -.TH form_page 3X "" +.\" $Id: form_page.3x,v 1.37 2024/03/16 15:35:01 tom Exp $ +.TH form_page 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .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 -.sp -\fBint set_current_field(FORM *\fP\fIform\fP\fB, FIELD *\fP\fIfield\fP\fB);\fP -.br -\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 -\fBint form_page(const FORM *\fP\fIform\fP\fB);\fP -.sp -\fBint field_index(const FIELD *\fP\fIfield\fP\fB);\fP -.br +.nf +\fB#include +.PP +\fBint set_current_field(FORM *\fIform\fP, FIELD *\fIfield\fP); +\fBFIELD *current_field(const FORM *\fIform\fP); +.PP +\fBint unfocus_current_field(FORM *\fIform\fP); +.PP +\fBint set_form_page(FORM *\fIform\fP, int \fIn\fP); +\fBint form_page(const FORM *\fIform\fP); +.PP +\fBint field_index(const FIELD *\fIfield\fP); +.fi .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. @@ -83,19 +82,17 @@ 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(3)). -. -.SH SEE ALSO -\fBcurses\fR(3X), \fBform\fR(3X). -.SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +System error occurred (see \fBerrno\fP(3)). .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. +The \fBunfocus_current_field\fP function is an \fI\%ncurses\fP +extension. .SH AUTHORS Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%form\fP(3X)