ncurses 6.2 - patch 20201205
[ncurses.git] / man / form_field_just.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright 2018-2019,2020 Thomas E. Dickey                                *
4 .\" Copyright 1998-2010,2015 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 .\"
31 .\" $Id: form_field_just.3x,v 1.18 2020/10/18 00:12:55 tom Exp $
32 .TH form_field_just 3X ""
33 .ie \n(.g .ds `` \(lq
34 .el       .ds `` ``
35 .ie \n(.g .ds '' \(rq
36 .el       .ds '' ''
37 .SH NAME
38 \fBset_field_just\fR,
39 \fBfield_just\fP \- retrieve field characteristics
40 .SH SYNOPSIS
41 \fB#include <form.h>\fR
42 .sp
43 \fBint set_field_just(FIELD *\fP\fIfield\fP\fB, int \fP\fIjustification\fP\fB);\fP
44 .br
45 \fBint field_just(const FIELD *\fP\fIfield\fP\fB);\fP
46 .br
47 .SH DESCRIPTION
48 The function \fBset_field_just\fR sets the justification attribute of
49 a field; \fBfield_just\fR returns a field's justification attribute.
50 The attribute may be one of NO_JUSTIFICATION, JUSTIFY_RIGHT,
51 JUSTIFY_LEFT, or JUSTIFY_CENTER.
52 .
53 .SH RETURN VALUE
54 The function \fBfield_just\fR returns one of: NO_JUSTIFICATION,
55 JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.
56 .PP
57 The function \fBset_field_just\fR returns one of the following:
58 .TP 5
59 .B E_OK
60 The routine succeeded.
61 .TP 5
62 .B E_SYSTEM_ERROR
63 System error occurred (see \fBerrno\fR(3)).
64 .TP 5
65 .B E_BAD_ARGUMENT
66 Routine detected an incorrect or out-of-range argument.
67 .SH SEE ALSO
68 \fBcurses\fR(3X) and related pages whose names begin \*(``form_\*('' for detailed
69 descriptions of the entry points.
70 .SH NOTES
71 The header file \fB<form.h>\fR automatically includes the header file
72 \fB<curses.h>\fR.
73 .SH PORTABILITY
74 These routines emulate the System V forms library.
75 They were not supported on
76 Version 7 or BSD versions.
77 .SH AUTHORS
78 Juergen Pfeifer.
79 Manual pages and adaptation for new curses by Eric S. Raymond.