08444ab694c70e53073a752a0324653de75b7240
[ncurses.git] / doc / html / man / form_field_just.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998-2002,2003 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_just.3x,v 1.7 2003/05/10 20:33:49 jmc Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>form_field_just 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>form_field_just 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
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>
45
46
47
48
49 </PRE>
50 <H2>NAME</H2><PRE>
51        <STRONG>form_field_just</STRONG> - retrieve field characteristics
52
53
54 </PRE>
55 <H2>SYNOPSIS</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);
59
60
61 </PRE>
62 <H2>DESCRIPTION</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.
67
68
69
70 </PRE>
71 <H2>RETURN VALUE</H2><PRE>
72        The  function <STRONG>field_just</STRONG> returns one of: NO_JUSTIFICATION,
73        JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.
74
75        The function <STRONG>set_field_just</STRONG> returns one of the following:
76
77        <STRONG>E_OK</STRONG> The routine succeeded.
78
79        <STRONG>E_SYSTEM_ERROR</STRONG>
80             System error occurred (see <STRONG>errno</STRONG>).
81
82        <STRONG>E_BAD_ARGUMENT</STRONG>
83             Routine detected an incorrect or  out-of-range  argu-
84             ment.
85
86
87 </PRE>
88 <H2>SEE ALSO</H2><PRE>
89        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
90        detailed descriptions of the entry points.
91
92
93 </PRE>
94 <H2>NOTES</H2><PRE>
95        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
96        file <STRONG>&lt;curses.h&gt;</STRONG>.
97
98
99 </PRE>
100 <H2>PORTABILITY</H2><PRE>
101        These  routines  emulate the System V forms library.  They
102        were not supported on Version 7 or BSD versions.
103
104
105 </PRE>
106 <H2>AUTHORS</H2><PRE>
107        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
108        curses by Eric S. Raymond.
109
110
111
112                                               <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG>
113 </PRE>
114 <HR>
115 <ADDRESS>
116 Man(1) output converted with
117 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
118 </ADDRESS>
119 </BODY>
120 </HTML>