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.5 Library calls</TITLE> 39<link rel="author" href="mailto:bug-ncurses@gnu.org"> 40 41</HEAD> 42<BODY> 43<H1 class="no-header">form_field_attributes 3x 2024-03-16 ncurses 6.5 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 49 50</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> 51 <STRONG>form_field_attributes</STRONG> - color and attribute control for form fields 52 53 54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> 55 <STRONG>#include</STRONG> <STRONG><form.h></STRONG> 56 57 <STRONG>int</STRONG> <STRONG>set_field_fore(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>attr</EM><STRONG>);</STRONG> 58 <STRONG>chtype</STRONG> <STRONG>field_fore(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG> 59 60 <STRONG>int</STRONG> <STRONG>set_field_back(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>chtype</STRONG> <EM>attr</EM><STRONG>);</STRONG> 61 <STRONG>chtype</STRONG> <STRONG>field_back(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG> 62 63 <STRONG>int</STRONG> <STRONG>set_field_pad(FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <EM>pad</EM><STRONG>);</STRONG> 64 <STRONG>int</STRONG> <STRONG>field_pad(const</STRONG> <STRONG>FIELD</STRONG> <STRONG>*</STRONG><EM>field</EM><STRONG>);</STRONG> 65 66 67</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> 68 The function <STRONG>set_field_fore</STRONG> sets the foreground attribute of <EM>field</EM>. 69 This is the highlight used to display the field contents. The function 70 <STRONG>field_fore</STRONG> returns the foreground attribute. The default is 71 <STRONG>A_STANDOUT</STRONG>. 72 73 The function <STRONG>set_field_back</STRONG> sets the background attribute of <EM>form</EM>. This 74 is the highlight used to display the extent fields in the form. The 75 function <STRONG>field_back</STRONG> returns the background attribute. The default is 76 <STRONG>A_NORMAL</STRONG>. 77 78 The function <STRONG>set_field_pad</STRONG> sets the character used to fill the field. 79 The function <STRONG>field_pad</STRONG> returns the given form's pad character. The 80 default is a blank. 81 82 83</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> 84 These routines return one of the following: 85 86 <STRONG>E_OK</STRONG> The routine succeeded. 87 88 <STRONG>E_BAD_ARGUMENT</STRONG> 89 Routine detected an incorrect or out-of-range argument. 90 91 <STRONG>E_SYSTEM_ERROR</STRONG> 92 System error occurred (see <STRONG>errno(3)</STRONG>). 93 94 95</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> 96 These routines emulate the System V forms library. They were not 97 supported on Version 7 or BSD versions. 98 99 100</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> 101 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. 102 Raymond. 103 104 105</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> 106 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for detailed 107 descriptions of the entry points. 108 109 110 111ncurses 6.5 2024-03-16 <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG> 112</PRE> 113<div class="nav"> 114<ul> 115<li><a href="#h2-NAME">NAME</a></li> 116<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> 117<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> 118<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> 119<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> 120<li><a href="#h2-AUTHORS">AUTHORS</a></li> 121<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> 122</ul> 123</div> 124</BODY> 125</HTML> 126