usr/src/man/man3curses/form_field_attributes.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_ATTRIBUTES 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_field_attributes, set_field_fore, field_fore, set_field_back, field_back,
  10 set_field_pad, field_pad \- format the general display attributes of 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_field_fore\fR(\fBFIELD *\fR\fIfield\fR, \fBchtype\fR \fIattr\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBchtype\fR \fBfield_fore\fR(\fBFIELD *\fR\fIfield\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBset_field_back\fR(\fBFIELD *\fR\fIfield\fR, \fBchtype\fR \fIattr\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBchtype\fR \fBfield_back\fR(\fBFIELD *\fR\fIfield\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBint\fR \fBset_field_pad\fR(\fBFIELD *\fR\fIfield\fR, \fBint\fR \fIpad\fR);
  38 .fi
  39
  40 .LP
  41 .nf
  42 \fBint\fR \fBfield_pad\fR(\fBFIELD *\fR\fIfield\fR);
  43 .fi
  44
  45 .SH DESCRIPTION
  46 .sp
  47 .LP
  48 \fBset_field_fore()\fR sets the foreground attribute of \fIfield\fR. The
  49 foreground attribute is the low-level \fBcurses\fR display attribute used to
  50 display the field contents. \fBfield_fore()\fR returns the foreground attribute
  51 of \fIfield\fR.
  52 .sp
  53 .LP
  54 \fBset_field_back()\fR sets the background attribute of \fIfield\fR. The
  55 background attribute is the low-level \fBcurses\fR display attribute used to
  56 display the extent of the field. \fBfield_back()\fR returns the background
  57 attribute of \fIfield\fR.
  58 .sp
  59 .LP
  60 \fBset_field_pad()\fR sets the pad character of \fIfield\fR to \fIpad\fR. The
  61 pad character is the character used to fill within the field. \fBfield_pad()\fR
  62 returns the pad character of \fIfield\fR.
  63 .SH RETURN VALUES
  64 .sp
  65 .LP
  66 \fBfield_fore()\fR, \fBfield_back()\fR, and \fBfield_pad()\fR return default
  67 values if \fIfield\fR is \fINULL\fR. If \fIfield\fR is not \fINULL\fR and is
  68 not a valid \fBFIELD\fR pointer, the return value from these routines is
  69 undefined.
  70 .sp
  71 .LP
  72 \fBset_field_fore()\fR, \fBset_field_back()\fR, and \fBset_field_pad()\fR
  73 return one of the following:
  74 .sp
  75 .ne 2
  76 .na
  77 \fBE_OK\fR
  78 .ad
  79 .RS 18n
  80 The function returned successfully.
  81 .RE
  82
  83 .sp
  84 .ne 2
  85 .na
  86 \fBE_SYSTEM_ERROR\fR
  87 .ad
  88 .RS 18n
  89 System error.
  90 .RE
  91
  92 .sp
  93 .ne 2
  94 .na
  95 \fBE_BAD_ARGUMENT\fR
  96 .ad
  97 .RS 18n
  98 An argument is incorrect.
  99 .RE
 100
 101 .SH ATTRIBUTES
 102 .sp
 103 .LP
 104 See \fBattributes\fR(5) for descriptions of the following attributes:
 105 .sp
 106
 107 .sp
 108 .TS
 109 box;
 110 c | c
 111 l | l .
 112 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 113 _
 114 MT-Level        Unsafe
 115 .TE
 116
 117 .SH SEE ALSO
 118 .sp
 119 .LP
 120 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
 121 .SH NOTES
 122 .sp
 123 .LP
 124 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 125 \fB<curses.h>\fR\&.