Content-type: text/html Man page of form_field_attributes

form_field_attributes

Section: Curses Library Functions (3CURSES)
Updated: 31 Dec 1996
Index Return to Main Contents
 

NAME

form_field_attributes, set_field_fore, field_fore, set_field_back, field_back, set_field_pad, field_pad - format the general display attributes of forms  

SYNOPSIS

cc [ flag... ] file... -lform -lcurses [ library... ]
#include <form.h>

int set_field_fore(FIELD *field, chtype attr);

chtype field_fore(FIELD *field);

int set_field_back(FIELD *field, chtype attr);

chtype field_back(FIELD *field);

int set_field_pad(FIELD *field, int pad);

int field_pad(FIELD *field);  

DESCRIPTION

set_field_fore() sets the foreground attribute of field. The foreground attribute is the low-level curses display attribute used to display the field contents. field_fore() returns the foreground attribute of field.

set_field_back() sets the background attribute of field. The background attribute is the low-level curses display attribute used to display the extent of the field. field_back() returns the background attribute of field.

set_field_pad() sets the pad character of field to pad. The pad character is the character used to fill within the field. field_pad() returns the pad character of field.  

RETURN VALUES

field_fore(), field_back(), and field_pad() return default values if field is NULL. If field is not NULL and is not a valid FIELD pointer, the return value from these routines is undefined.

set_field_fore(), set_field_back(), and set_field_pad() return one of the following:

E_OK The function returned successfully.

E_SYSTEM_ERROR System error.

E_BAD_ARGUMENT An argument is incorrect.

 

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPEATTRIBUTE VALUE
MT-LevelUnsafe

 

SEE ALSO

curses(3CURSES), forms(3CURSES), attributes(5)  

NOTES

The header <form.h> automatically includes the headers <eti.h> and <curses.h>.


 

Index

NAME
SYNOPSIS
DESCRIPTION
RETURN VALUES
ATTRIBUTES
SEE ALSO
NOTES

This document was created by man2html, using the manual pages.
Time: 02:38:37 GMT, October 02, 2010