Debian Codegraph @

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

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