man7.org > Linux > man-pages

Linux/UNIX system programming training

form_field_attributes(3x) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | NOTES | PORTABILITY | AUTHORS | COLOPHON 

form_field_attributes(3X)                      form_field_attributes(3X)

NAME         top

       form_field_attributes - color and attribute control for form
       fields

SYNOPSIS         top

       #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         top

       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         top

       These routines return one of the following:

       E_OK The routine succeeded.

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

       E_SYSTEM_ERROR
            System error occurred (see errno(3)).

SEE ALSO         top

       curses(3X) and related pages whose names begin “form_” for
       detailed descriptions of the entry points.

NOTES         top

       The header file <form.h> automatically includes the header file
       <curses.h>.

PORTABILITY         top

       These routines emulate the System V forms library.  They were not
       supported on Version 7 or BSD versions.

AUTHORS         top

       Juergen Pfeifer.  Manual pages and adaptation for new curses by
       Eric S. Raymond.

COLOPHON         top

       This page is part of the ncurses (new curses) project.
       Information about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have
       a bug report for this manual page, send it to
       bug-ncurses-request@gnu.org.  This page was obtained from the
       project's upstream Git mirror of the CVS repository
       ⟨https://github.com/mirror/ncurses.git⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-03-12.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

                                               form_field_attributes(3X)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI