xref: /freebsd/contrib/ncurses/man/form_field_attributes.3x (revision 1e413cf93298b5b97441a21d9a50fdcd0ee9945e)
t
***************************************************************************
Copyright (c) 1998-2002,2006 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: form_field_attributes.3x,v 1.10 2006/11/04 18:51:26 tom Exp $
form_field_attributes 3X ""
NAME
form_field_attributes - color and attribute control for form fields
SYNOPSIS
#include <form.h>

int set_field_fore(FIELD *field, chtype attr);

chtype field_fore(const FIELD *field);

int set_field_back(FIELD *field, chtype attr);

chtype field_back(const FIELD *field);

int set_field_pad(FIELD *field, int pad);

int field_pad(const FIELD *field);

DESCRIPTION
The function set_field_fore sets the foreground attribute of field. This is the highlight used to display the field contents. The function field_fore returns the foreground attribute. The default is A_STANDOUT.

The function set_field_back sets the background attribute of form. This is the highlight used to display the extent fields in the form. The function field_back returns the background attribute. The default is A_NORMAL.

The function set_field_pad sets the character used to fill the field. The function field_pad returns the given form's pad character. The default is a blank.

RETURN VALUE
These routines return one of the following:

5 E_OK The routine succeeded.

5 E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument.

5 E_SYSTEM_ERROR System error occurred (see errno). .

SEE ALSO
curses(3X) and related pages whose names begin "form_" for detailed descriptions of the entry points.
NOTES
The header file <form.h> automatically includes the header file <curses.h>.
PORTABILITY
These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions.
AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. #
# The following sets edit modes for GNU EMACS
# Local Variables:
# mode:nroff
# fill-column:79
# End: