| 1 | '\" t
|
|---|
| 2 | .\"***************************************************************************
|
|---|
| 3 | .\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
|
|---|
| 4 | .\" *
|
|---|
| 5 | .\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|---|
| 6 | .\" copy of this software and associated documentation files (the *
|
|---|
| 7 | .\" "Software"), to deal in the Software without restriction, including *
|
|---|
| 8 | .\" without limitation the rights to use, copy, modify, merge, publish, *
|
|---|
| 9 | .\" distribute, distribute with modifications, sublicense, and/or sell *
|
|---|
| 10 | .\" copies of the Software, and to permit persons to whom the Software is *
|
|---|
| 11 | .\" furnished to do so, subject to the following conditions: *
|
|---|
| 12 | .\" *
|
|---|
| 13 | .\" The above copyright notice and this permission notice shall be included *
|
|---|
| 14 | .\" in all copies or substantial portions of the Software. *
|
|---|
| 15 | .\" *
|
|---|
| 16 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|---|
| 17 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|---|
| 18 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|---|
| 19 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|---|
| 20 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|---|
| 21 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|---|
| 22 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|---|
| 23 | .\" *
|
|---|
| 24 | .\" Except as contained in this notice, the name(s) of the above copyright *
|
|---|
| 25 | .\" holders shall not be used in advertising or otherwise to promote the *
|
|---|
| 26 | .\" sale, use or other dealings in this Software without prior written *
|
|---|
| 27 | .\" authorization. *
|
|---|
| 28 | .\"***************************************************************************
|
|---|
| 29 | .\"
|
|---|
| 30 | .\" $Id: form_field_attributes.3x,v 1.12 2010/12/04 18:40:45 tom Exp $
|
|---|
| 31 | .TH form_field_attributes 3X ""
|
|---|
| 32 | .SH NAME
|
|---|
| 33 | \fBform_field_attributes\fR \- color and attribute control for form fields
|
|---|
| 34 | .SH SYNOPSIS
|
|---|
| 35 | \fB#include <form.h>\fR
|
|---|
| 36 | .br
|
|---|
| 37 | int set_field_fore(FIELD *field, chtype attr);
|
|---|
| 38 | .br
|
|---|
| 39 | chtype field_fore(const FIELD *field);
|
|---|
| 40 | .br
|
|---|
| 41 | int set_field_back(FIELD *field, chtype attr);
|
|---|
| 42 | .br
|
|---|
| 43 | chtype field_back(const FIELD *field);
|
|---|
| 44 | .br
|
|---|
| 45 | int set_field_pad(FIELD *field, int pad);
|
|---|
| 46 | .br
|
|---|
| 47 | int field_pad(const FIELD *field);
|
|---|
| 48 | .br
|
|---|
| 49 | .SH DESCRIPTION
|
|---|
| 50 | The function \fBset_field_fore\fR sets the foreground attribute of
|
|---|
| 51 | \fIfield\fR. This is the highlight used to display the field contents. The
|
|---|
| 52 | function \fBfield_fore\fR returns the foreground attribute. The default is
|
|---|
| 53 | \fBA_STANDOUT\fR.
|
|---|
| 54 | .PP
|
|---|
| 55 | The function \fBset_field_back\fR sets the background attribute of
|
|---|
| 56 | \fIform\fR. This is the highlight used to display the extent fields in the
|
|---|
| 57 | form. The function \fBfield_back\fR returns the background attribute. The
|
|---|
| 58 | default is \fBA_NORMAL\fR.
|
|---|
| 59 | .PP
|
|---|
| 60 | The function \fBset_field_pad\fR sets the character used to fill the field.
|
|---|
| 61 | The function \fBfield_pad\fR returns the given form's pad character. The
|
|---|
| 62 | default is a blank.
|
|---|
| 63 | .SH RETURN VALUE
|
|---|
| 64 | These routines return one of the following:
|
|---|
| 65 | .TP 5
|
|---|
| 66 | .B E_OK
|
|---|
| 67 | The routine succeeded.
|
|---|
| 68 | .TP 5
|
|---|
| 69 | .B E_BAD_ARGUMENT
|
|---|
| 70 | Routine detected an incorrect or out-of-range argument.
|
|---|
| 71 | .TP 5
|
|---|
| 72 | .B E_SYSTEM_ERROR
|
|---|
| 73 | System error occurred (see \fBerrno\fR).
|
|---|
| 74 | .
|
|---|
| 75 | .SH SEE ALSO
|
|---|
| 76 | \fBcurses\fR(3X) and related pages whose names begin "form_" for detailed
|
|---|
| 77 | descriptions of the entry points.
|
|---|
| 78 | .SH NOTES
|
|---|
| 79 | The header file \fB<form.h>\fR automatically includes the header file
|
|---|
| 80 | \fB<curses.h>\fR.
|
|---|
| 81 | .SH PORTABILITY
|
|---|
| 82 | These routines emulate the System V forms library. They were not supported on
|
|---|
| 83 | Version 7 or BSD versions.
|
|---|
| 84 | .SH AUTHORS
|
|---|
| 85 | Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
|
|---|
| 86 | S. Raymond.
|
|---|
