doc/html/man/form_field_attributes.3x.html

   1 <HTML>
   2 <BODY>
   3 <PRE>
   4 <!-- Manpage converted by man2html 3.0.1 -->
   5
   6 </PRE>
   7 <H2>NAME</H2><PRE>
   8        <B>form_field_attributes</B>  -  color  and attribute control for
   9        form fields
  10
  11
  12 </PRE>
  13 <H2>SYNOPSIS</H2><PRE>
  14        <B>#include</B> <B>&lt;form.h&gt;</B>
  15        int set_field_fore(FIELD *field, chtype attr);
  16        chtype field_fore(const FIELD *field);
  17        int set_field_back(FIELD *field, chtype attr);
  18        chtype field_back(const FIELD *field);
  19        int set_field_pad(FIELD *field, int pad);
  20        chtype field_pad(const FIELD *field);
  21
  22
  23 </PRE>
  24 <H2>DESCRIPTION</H2><PRE>
  25        The function <B>set_field_fore</B> sets the foreground  attribute
  26        of  <I>field</I>. This is the highlight used to display the field
  27        contents.  The function <B>field_fore</B> returns the  foreground
  28        attribute.  The default is <B>A_STANDOUT</B>.
  29
  30        The  function <B>set_field_back</B> sets the background attribute
  31        of <I>form</I>. This is the highlight used to display the  extent
  32        fields  in  the form.  The function <B>field_back</B> returns the
  33        background attribute.  The default is <B>A_NORMAL</B>.
  34
  35        The function <B>set_field_pad</B> sets the character used to fill
  36        the  field.   The  function  <B>field_pad</B>  returns  the given
  37        form's pad character.  The default is a blank.
  38
  39
  40 </PRE>
  41 <H2>RETURN VALUE</H2><PRE>
  42        These routines return one of the following:
  43
  44        <B>E_OK</B> The routine succeeded.
  45
  46        <B>E_SYSTEM_ERROR</B>
  47             System error occurred (see <B>errno</B>).
  48
  49        <B>E_BAD_ARGUMENT</B>
  50             Routine detected an incorrect or  out-of-range  argu-
  51             ment.
  52
  53
  54 </PRE>
  55 <H2>SEE ALSO</H2><PRE>
  56        <B><A HREF="ncurses.3x.html">curses(3x)</A></B>  and  3x  pages  whose  names begin "form_" for
  57        detailed descriptions of the entry points.
  58
  59
  60 </PRE>
  61 <H2>NOTES</H2><PRE>
  62        The header file <B>&lt;form.h&gt;</B> automatically includes the header
  63        file <B>&lt;curses.h&gt;</B>.
  64
  65
  66 </PRE>
  67 <H2>PORTABILITY</H2><PRE>
  68        These  routines  emulate the System V forms library.  They
  69        were not supported on Version 7 or BSD versions.
  70
  71
  72 </PRE>
  73 <H2>AUTHORS</H2><PRE>
  74        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
  75        curses by Eric S. Raymond.
  76
  77
  78
  79
  80
  81
  82
  83
  84
  85
  86
  87
  88
  89
  90
  91
  92
  93
  94
  95
  96
  97
  98
  99
 100
 101
 102
 103
 104
 105
 106
 107
 108
 109
 110
 111
 112
 113
 114
 115
 116
 117
 118
 119
 120
 121
 122
 123
 124
 125
 126
 127
 128
 129 </PRE>
 130 <HR>
 131 <ADDRESS>
 132 Man(1) output converted with
 133 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 134 </ADDRESS>
 135 </BODY>
 136 </HTML>