usr/src/man/man3curses/form_field.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_FIELD 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_field, set_form_fields, form_fields, field_count, move_field \- connect
  10 fields to forms
  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_fields\fR(\fBFORM *\fR\fIform\fR, \fBFIELD **\fR\fIfield\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBFIELD **\fR\fBform_fields\fR(\fBFORM *\fR\fIform\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBfield_count\fR(\fBFORM *\fR\fIform\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBint\fR \fBmove_field\fR(\fBFIELD *\fR\fIfield\fR, \fBint\fR \fIfrow\fR, \fBint\fR \fIfcol\fR);
  33 .fi
  34
  35 .SH DESCRIPTION
  36 .sp
  37 .LP
  38 \fBset_form_fields()\fR changes the fields connected to \fIform\fR to
  39 \fIfields\fR. The original fields are disconnected.
  40 .sp
  41 .LP
  42 \fBform_fields()\fR returns a pointer to the field pointer array connected to
  43 \fIform\fR.
  44 .sp
  45 .LP
  46 \fBfield_count()\fR returns the number of fields connected to \fIform\fR.
  47 .sp
  48 .LP
  49 \fBmove_field()\fR moves the disconnected \fIfield\fR to the location \fIfrow,
  50 fcol\fR in the \fBforms\fR subwindow.
  51 .SH RETURN VALUES
  52 .sp
  53 .LP
  54 \fBform_fields()\fR returns \fINULL\fR on error.
  55 .sp
  56 .LP
  57 \fBfield_count()\fR returns \fB-1\fR on error.
  58 .sp
  59 .LP
  60 \fBset_form_fields()\fR and \fBmove_field()\fR return one of the following:
  61 .sp
  62 .ne 2
  63 .na
  64 \fBE_OK \fR
  65 .ad
  66 .RS 18n
  67 The function returned successfully.
  68 .RE
  69
  70 .sp
  71 .ne 2
  72 .na
  73 \fBE_CONNECTED\fR
  74 .ad
  75 .RS 18n
  76 The field is already connected to a form.
  77 .RE
  78
  79 .sp
  80 .ne 2
  81 .na
  82 \fBE_SYSTEM_ERROR\fR
  83 .ad
  84 .RS 18n
  85 System error.
  86 .RE
  87
  88 .sp
  89 .ne 2
  90 .na
  91 \fBE_BAD_ARGUMENT\fR
  92 .ad
  93 .RS 18n
  94 An argument is incorrect
  95 .RE
  96
  97 .sp
  98 .ne 2
  99 .na
 100 \fBE_POSTED\fR
 101 .ad
 102 .RS 18n
 103 The form is posted.
 104 .RE
 105
 106 .SH ATTRIBUTES
 107 .sp
 108 .LP
 109 See \fBattributes\fR(5) for descriptions of the following attributes:
 110 .sp
 111
 112 .sp
 113 .TS
 114 box;
 115 c | c
 116 l | l .
 117 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 118 _
 119 MT-Level        Unsafe
 120 .TE
 121
 122 .SH SEE ALSO
 123 .sp
 124 .LP
 125 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
 126 .SH NOTES
 127 .sp
 128 .LP
 129 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 130 \fB<curses.h>\fR\&.