usr/src/man/man3curses/form_page.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH FORM_PAGE 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_page, set_form_page, set_current_field, current_field, field_index \- set
  10 forms current page and field
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lform\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  15 #include <form.h>
  16
  17 \fBint\fR \fBset_form_page\fR(\fBFORM *\fR\fIform\fR, \fBint\fR \fIpage\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBint\fR \fBform_page\fR(\fBFORM *\fR\fIform\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBset_current_field\fR(\fBFORM *\fR\fIform\fR, \fBFIELD *\fR\fIfield\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBFIELD *\fR\fBcurrent_field\fR(\fBFORM*\fR\fIform\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBint\fR \fBfield_index\fR(\fBFIELD *\fR\fIfield\fR);
  38 .fi
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 \fBset_form_page()\fR sets the page number of \fIform\fR to \fBpage\fR.
  44 \fBform_page()\fR returns the current page number of \fIform\fR.
  45 .sp
  46 .LP
  47 \fBset_current_field()\fR sets the current field of \fIform\fR to \fIfield\fR.
  48 \fBcurrent_field()\fR returns a pointer to the current field of \fIform\fR.
  49 .sp
  50 .LP
  51 \fBfield_index()\fR returns the index in the field pointer array of
  52 \fIfield\fR.
  53 .SH RETURN VALUES
  54 .sp
  55 .LP
  56 \fBform_page()\fR returns \fB-1\fR on error.
  57 .sp
  58 .LP
  59 \fBcurrent_field()\fR returns \fINULL\fR on error.
  60 .sp
  61 .LP
  62 \fBfield_index()\fR returns \fB-1\fR on error.
  63 .sp
  64 .LP
  65 \fBset_form_page()\fR and \fBset_current_field()\fR return one of the
  66 following:
  67 .sp
  68 .ne 2
  69 .na
  70 \fBE_OK\fR
  71 .ad
  72 .RS 20n
  73 The function returned successfully.
  74 .RE
  75
  76 .sp
  77 .ne 2
  78 .na
  79 \fBE_SYSTEM_ERROR\fR
  80 .ad
  81 .RS 20n
  82 System error.
  83 .RE
  84
  85 .sp
  86 .ne 2
  87 .na
  88 \fBE_BAD_ARGUMENT\fR
  89 .ad
  90 .RS 20n
  91 An argument is incorrect.
  92 .RE
  93
  94 .sp
  95 .ne 2
  96 .na
  97 \fBE_BAD_STATE\fR
  98 .ad
  99 .RS 20n
 100 The routine was called from an initialization or termination function.
 101 .RE
 102
 103 .sp
 104 .ne 2
 105 .na
 106 \fBE_INVALID_FIELD\fR
 107 .ad
 108 .RS 20n
 109 The field contents are invalid.
 110 .RE
 111
 112 .sp
 113 .ne 2
 114 .na
 115 \fBE_REQUEST_DENIED\fR
 116 .ad
 117 .RS 20n
 118 The form driver request failed
 119 .RE
 120
 121 .SH ATTRIBUTES
 122 .sp
 123 .LP
 124 See \fBattributes\fR(5) for descriptions of the following attributes:
 125 .sp
 126
 127 .sp
 128 .TS
 129 box;
 130 c | c
 131 l | l .
 132 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 133 _
 134 MT-Level        Unsafe
 135 .TE
 136
 137 .SH SEE ALSO
 138 .sp
 139 .LP
 140 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
 141 .SH NOTES
 142 .sp
 143 .LP
 144 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 145 \fB<curses.h>\fR\&.