]> ncurses.scripts.mit.edu Git - ncurses.git/blobdiff - doc/html/man/form_field_attributes.3x.html
ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / form_field_attributes.3x.html
index 814637a365fc83e0b73b040cd68974b08db7c1a2..92435e8b136fb8f976d61f11a23242e844297423 100644 (file)
@@ -1,7 +1,8 @@
-<!-- 
+<!--
   * t
   ****************************************************************************
-  * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
+  * Copyright 2018-2019,2020 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            *
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: form_field_attributes.3x,v 1.12 2010/12/04 18:40:45 tom Exp @
+  * @Id: form_field_attributes.3x,v 1.18 2020/10/18 00:14:20 tom Exp @
 -->
 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
 <HTML>
 <HEAD>
 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>form_field_attributes 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<TITLE>form_field_attributes 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
 </HEAD>
 <BODY>
-<H1 class="no-header">form_field_attributes 3x</H1>
+<H1 class="no-header">form_field_attributes 3X</H1>
 <PRE>
-<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>
+<B><A HREF="form_field_attributes.3X.html">form_field_attributes(3X)</A></B>                            <B><A HREF="form_field_attributes.3X.html">form_field_attributes(3X)</A></B>
 
 
 
 
 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
-       <STRONG>form_field_attributes</STRONG> - color and attribute control for form fields
+       <B>form_field_attributes</B> - color and attribute control for form fields
 
 
 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
-       <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
-       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);
+       <B>#include</B> <B>&lt;form.h&gt;</B>
+
+       <B>int</B> <B>set_field_fore(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>chtype</B> <I>attr</I><B>);</B>
+       <B>chtype</B> <B>field_fore(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>);</B>
+
+       <B>int</B> <B>set_field_back(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>chtype</B> <I>attr</I><B>);</B>
+       <B>chtype</B> <B>field_back(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>);</B>
+
+       <B>int</B> <B>set_field_pad(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>int</B> <I>pad</I><B>);</B>
+       <B>int</B> <B>field_pad(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>);</B>
 
 
 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
-       The  function  <STRONG>set_field_fore</STRONG>  sets  the foreground attribute of <EM>field</EM>.
+       The  function  <B>set_field_fore</B>  sets  the foreground attribute of <I>field</I>.
        This is the highlight used to display the field contents.  The function
-       <STRONG>field_fore</STRONG>  returns  the foreground attribute.  The default is <STRONG>A_STAND-</STRONG>
-       <STRONG>OUT</STRONG>.
+       <B>field_fore</B>   returns   the   foreground   attribute.   The  default  is
+       <B>A_STANDOUT</B>.
 
-       The function <STRONG>set_field_back</STRONG> sets the background attribute of <EM>form</EM>. This
+       The function <B>set_field_back</B> sets the background attribute of <I>form</I>. This
        is  the  highlight  used to display the extent fields in the form.  The
-       function <STRONG>field_back</STRONG> returns the background attribute.  The  default  is
-       <STRONG>A_NORMAL</STRONG>.
+       function <B>field_back</B> returns the background attribute.  The  default  is
+       <B>A_NORMAL</B>.
 
-       The  function  <STRONG>set_field_pad</STRONG> sets the character used to fill the field.
-       The function <STRONG>field_pad</STRONG> returns the given  form's  pad  character.   The
+       The  function  <B>set_field_pad</B> sets the character used to fill the field.
+       The function <B>field_pad</B> returns the given  form's  pad  character.   The
        default is a blank.
 
 
 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
        These routines return one of the following:
 
-       <STRONG>E_OK</STRONG> The routine succeeded.
+       <B>E_OK</B> The routine succeeded.
 
-       <STRONG>E_BAD_ARGUMENT</STRONG>
+       <B>E_BAD_ARGUMENT</B>
             Routine detected an incorrect or out-of-range argument.
 
-       <STRONG>E_SYSTEM_ERROR</STRONG>
-            System error occurred (see <STRONG>errno</STRONG>).
+       <B>E_SYSTEM_ERROR</B>
+            System error occurred (see <B>errno(3)</B>).
 
 
 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
-       <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>  and  related  pages  whose names begin "form_" for detailed
+       <B><A HREF="curses.3X.html">curses(3X)</A></B>  and  related  pages  whose names begin "form_" for detailed
        descriptions of the entry points.
 
 
 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
-       The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
-       <STRONG>&lt;curses.h&gt;</STRONG>.
+       The  header  file  <B>&lt;form.h&gt;</B>  automatically  includes  the  header  file
+       <B>&lt;curses.h&gt;</B>.
 
 
 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
-       These  routines emulate the System V forms library.  They were not sup-
-       ported on Version 7 or BSD versions.
+       These  routines  emulate  the  System  V  forms library.  They were not
+       supported on Version 7 or BSD versions.
 
 
 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 
 
 
-                                                     <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
+                                                     <B><A HREF="form_field_attributes.3X.html">form_field_attributes(3X)</A></B>
 </PRE>
 <div class="nav">
 <ul>