libncurses: updated to 6.0
[tomato.git] / release / src / router / libncurses / doc / html / man / form_field_just.3x.html
blob34a3bea1d63752667fd8cc6fdfb0ed45fec180b2
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_just.3x,v 1.11 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_just 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 class="no-header">form_field_just 3x</H1>
43 <PRE>
44 <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG> <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG>
49 </PRE>
50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>form_field_just</STRONG> - retrieve field characteristics
54 </PRE>
55 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
56 <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
57 int set_field_just(FIELD *field, int justification);
58 int field_just(const FIELD *field);
61 </PRE>
62 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
63 The function <STRONG>set_field_just</STRONG> sets the justification
64 attribute of a field; <STRONG>field_just</STRONG> returns a field's justi-
65 fication attribute. The attribute may be one of NO_JUSTI-
66 FICATION, JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.
69 </PRE>
70 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
71 The function <STRONG>field_just</STRONG> returns one of: NO_JUSTIFICATION,
72 JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.
74 The function <STRONG>set_field_just</STRONG> returns one of the following:
76 <STRONG>E_OK</STRONG> The routine succeeded.
78 <STRONG>E_SYSTEM_ERROR</STRONG>
79 System error occurred (see <STRONG>errno</STRONG>).
81 <STRONG>E_BAD_ARGUMENT</STRONG>
82 Routine detected an incorrect or out-of-range argu-
83 ment.
86 </PRE>
87 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
88 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
89 detailed descriptions of the entry points.
92 </PRE>
93 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
94 The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
95 file <STRONG>&lt;curses.h&gt;</STRONG>.
98 </PRE>
99 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
100 These routines emulate the System V forms library. They
101 were not supported on Version 7 or BSD versions.
104 </PRE>
105 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
106 Juergen Pfeifer. Manual pages and adaptation for new
107 curses by Eric S. Raymond.
111 <STRONG><A HREF="form_field_just.3x.html">form_field_just(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-SEE-ALSO">SEE ALSO</a></li>
120 <li><a href="#h2-NOTES">NOTES</a></li>
121 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
122 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
123 </ul>
124 </div>
125 </BODY>
126 </HTML>