ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / form_field_just.3x.html
1 <!--
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2010,2015 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.18 2020/10/18 00:12:55 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_just 3X</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">form_field_just 3X</H1>
44 <PRE>
45 <B><A HREF="form_field_just.3X.html">form_field_just(3X)</A></B>                                        <B><A HREF="form_field_just.3X.html">form_field_just(3X)</A></B>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <B>set_field_just</B>, <B>field_just</B> - retrieve field characteristics
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <B>#include</B> <B>&lt;form.h&gt;</B>
56
57        <B>int</B> <B>set_field_just(FIELD</B> <B>*</B><I>field</I><B>,</B> <B>int</B> <I>justification</I><B>);</B>
58        <B>int</B> <B>field_just(const</B> <B>FIELD</B> <B>*</B><I>field</I><B>);</B>
59
60
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62        The  function  <B>set_field_just</B>  sets  the  justification  attribute of a
63        field; <B>field_just</B>  returns  a  field's  justification  attribute.   The
64        attribute  may be one of NO_JUSTIFICATION, JUSTIFY_RIGHT, JUSTIFY_LEFT,
65        or JUSTIFY_CENTER.
66
67
68 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
69        The   function   <B>field_just</B>   returns   one    of:    NO_JUSTIFICATION,
70        JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.
71
72        The function <B>set_field_just</B> returns one of the following:
73
74        <B>E_OK</B> The routine succeeded.
75
76        <B>E_SYSTEM_ERROR</B>
77             System error occurred (see <B>errno(3)</B>).
78
79        <B>E_BAD_ARGUMENT</B>
80             Routine detected an incorrect or out-of-range argument.
81
82
83 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
84        <B><A HREF="curses.3X.html">curses(3X)</A></B>  and  related  pages  whose names begin "form_" for detailed
85        descriptions of the entry points.
86
87
88 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
89        The  header  file  <B>&lt;form.h&gt;</B>  automatically  includes  the  header  file
90        <B>&lt;curses.h&gt;</B>.
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
104                                                            <B><A HREF="form_field_just.3X.html">form_field_just(3X)</A></B>
105 </PRE>
106 <div class="nav">
107 <ul>
108 <li><a href="#h2-NAME">NAME</a></li>
109 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
110 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
111 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
112 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
113 <li><a href="#h2-NOTES">NOTES</a></li>
114 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
115 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
116 </ul>
117 </div>
118 </BODY>
119 </HTML>