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

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
   5   *                                                                          *
   6   * Permission is hereby granted, free of charge, to any person obtaining a  *
   7   * copy of this software and associated documentation files (the            *
   8   * "Software"), to deal in the Software without restriction, including      *
   9   * without limitation the rights to use, copy, modify, merge, publish,      *
  10   * distribute, distribute with modifications, sublicense, and/or sell       *
  11   * copies of the Software, and to permit persons to whom the Software is    *
  12   * furnished to do so, subject to the following conditions:                 *
  13   *                                                                          *
  14   * The above copyright notice and this permission notice shall be included  *
  15   * in all copies or substantial portions of the Software.                   *
  16   *                                                                          *
  17   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  18   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  19   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  20   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  21   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  22   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  23   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  24   *                                                                          *
  25   * Except as contained in this notice, the name(s) of the above copyright   *
  26   * holders shall not be used in advertising or otherwise to promote the     *
  27   * sale, use or other dealings in this Software without prior written       *
  28   * authorization.                                                           *
  29   ****************************************************************************
  30   * @Id: form_field_attributes.3x,v 1.12 2010/12/04 18:40:45 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>form_field_attributes 3x</TITLE>
  38 <link rev=made href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1>form_field_attributes 3x</H1>
  43 <HR>
  44 <PRE>
  45 <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>                     <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE>
  51 <H2><a name="h2-NAME">NAME</a></H2><PRE>
  52        <STRONG>form_field_attributes</STRONG>  -  color  and attribute control for
  53        form fields
  54
  55
  56 </PRE>
  57 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  58        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  59        int set_field_fore(FIELD *field, chtype attr);
  60        chtype field_fore(const FIELD *field);
  61        int set_field_back(FIELD *field, chtype attr);
  62        chtype field_back(const FIELD *field);
  63        int set_field_pad(FIELD *field, int pad);
  64        int field_pad(const FIELD *field);
  65
  66
  67 </PRE>
  68 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  69        The function <STRONG>set_field_fore</STRONG> sets the foreground  attribute
  70        of  <EM>field</EM>. This is the highlight used to display the field
  71        contents.  The function <STRONG>field_fore</STRONG> returns the  foreground
  72        attribute.  The default is <STRONG>A_STANDOUT</STRONG>.
  73
  74        The  function <STRONG>set_field_back</STRONG> sets the background attribute
  75        of <EM>form</EM>. This is the highlight used to display the  extent
  76        fields  in  the form.  The function <STRONG>field_back</STRONG> returns the
  77        background attribute.  The default is <STRONG>A_NORMAL</STRONG>.
  78
  79        The function <STRONG>set_field_pad</STRONG> sets the character used to fill
  80        the  field.   The  function  <STRONG>field_pad</STRONG>  returns  the given
  81        form's pad character.  The default is a blank.
  82
  83
  84 </PRE>
  85 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  86        These routines return one of the following:
  87
  88        <STRONG>E_OK</STRONG> The routine succeeded.
  89
  90        <STRONG>E_BAD_ARGUMENT</STRONG>
  91             Routine detected an incorrect or  out-of-range  argu-
  92             ment.
  93
  94        <STRONG>E_SYSTEM_ERROR</STRONG>
  95             System error occurred (see <STRONG>errno</STRONG>).
  96
  97
  98 </PRE>
  99 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 100        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
 101        detailed descriptions of the entry points.
 102
 103
 104 </PRE>
 105 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 106        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
 107        file <STRONG>&lt;curses.h&gt;</STRONG>.
 108
 109
 110 </PRE>
 111 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 112        These  routines  emulate the System V forms library.  They
 113        were not supported on Version 7 or BSD versions.
 114
 115
 116 </PRE>
 117 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 118        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
 119        curses by Eric S. Raymond.
 120
 121
 122
 123                                               <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
 124 </PRE>
 125 <div class="nav">
 126 <ul>
 127 <li><a href="#h2-NAME">NAME</a></li>
 128 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 129 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 130 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 131 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 132 <li><a href="#h2-NOTES">NOTES</a></li>
 133 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 134 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 135 </ul>
 136 </div>
 137 </BODY>
 138 </HTML>