X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=man%2Fform_field_attributes.3x;h=5a90cf8be9e46d6ac58808b6b8951476b5d2f2f4;hb=6fd6dd99d32385a01ca639d1d56b90b13e9c1d33;hp=ac7a3b53eeceb1eb6b7961cd9faa054af2dc5282;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01;p=ncurses.git diff --git a/man/form_field_attributes.3x b/man/form_field_attributes.3x index ac7a3b53..5a90cf8b 100644 --- a/man/form_field_attributes.3x +++ b/man/form_field_attributes.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2001,2002 Free Software Foundation, Inc. * +.\" Copyright 2018-2021,2022 Thomas E. Dickey * +.\" Copyright 1998-2006,2010 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 * @@ -27,65 +28,69 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: form_field_attributes.3x,v 1.7 2002/01/19 22:48:14 tom Exp $ +.\" $Id: form_field_attributes.3x,v 1.21 2022/02/12 20:03:40 tom Exp $ .TH form_field_attributes 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .SH NAME -\fBform_field_attributes\fR - color and attribute control for form fields +\fBform_field_attributes\fP \- color and attribute control for form fields .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.sp +\fBint set_field_fore(FIELD *\fIfield\fB, chtype \fIattr\fB);\fR .br -int set_field_fore(FIELD *field, chtype attr); +\fBchtype field_fore(const FIELD *\fIfield\fB);\fR +.sp +\fBint set_field_back(FIELD *\fIfield\fB, chtype \fIattr\fB);\fR .br -chtype field_fore(const FIELD *field); +\fBchtype field_back(const FIELD *\fIfield\fB);\fR +.sp +\fBint set_field_pad(FIELD *\fIfield\fB, int \fIpad\fB);\fR .br -int set_field_back(FIELD *field, chtype attr); -.br -chtype field_back(const FIELD *field); -.br -int set_field_pad(FIELD *field, int pad); -.br -int field_pad(const FIELD *field); +\fBint field_pad(const FIELD *\fIfield\fB);\fR .br .SH DESCRIPTION -The function \fBset_field_fore\fR sets the foreground attribute of -\fIfield\fR. This is the highlight used to display the field contents. The -function \fBfield_fore\fR returns the foreground attribute. The default is -\fBA_STANDOUT\fR. - -The function \fBset_field_back\fR sets the background attribute of -\fIform\fR. This is the highlight used to display the extent fields in the -form. The function \fBfield_back\fR returns the background attribute. The -default is \fBA_NORMAL\fR. - -The function \fBset_field_pad\fR sets the character used to fill the field. -The function \fBfield_pad\fR returns the given form's pad character. The +The function \fBset_field_fore\fP sets the foreground attribute of +\fIfield\fP. This is the highlight used to display the field contents. The +function \fBfield_fore\fP returns the foreground attribute. +The default is +\fBA_STANDOUT\fP. +.PP +The function \fBset_field_back\fP sets the background attribute of +\fIform\fP. This is the highlight used to display the extent fields in the +form. +The function \fBfield_back\fP returns the background attribute. +The +default is \fBA_NORMAL\fP. +.PP +The function \fBset_field_pad\fP sets the character used to fill the field. +The function \fBfield_pad\fP returns the given form's pad character. +The default is a blank. .SH RETURN VALUE These routines return one of the following: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). -.TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. +.TP 5 +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fP(3)). +. .SH SEE ALSO -\fBcurses\fR(3X) and related pages whose names begin "form_" for detailed +\fBcurses\fP(3X) and related pages whose names begin \*(``form_\*('' for detailed descriptions of the entry points. .SH NOTES -The header file \fB\fR automatically includes the header file -\fB\fR. +The header file \fB\fP automatically includes the header file +\fB\fP. .SH PORTABILITY -These routines emulate the System V forms library. They were not supported on +These routines emulate the System V forms library. +They were not supported on Version 7 or BSD versions. .SH 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: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.