2f223e91e7bfa3c85c8fd0fa5383d134d975e11b
[ncurses.git] / man / form_field_just.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: form_field_just.3x,v 1.11 2010/12/04 18:40:45 tom Exp $
31 .TH form_field_just 3X ""
32 .SH NAME
33 \fBform_field_just\fR \- retrieve field characteristics
34 .SH SYNOPSIS
35 \fB#include <form.h>\fR
36 .br
37 int set_field_just(FIELD *field, int justification);
38 .br
39 int field_just(const FIELD *field);
40 .br
41 .SH DESCRIPTION
42 The function \fBset_field_just\fR sets the justification attribute of
43 a field; \fBfield_just\fR returns a field's justification attribute.
44 The attribute may be one of NO_JUSTIFICATION, JUSTIFY_RIGHT,
45 JUSTIFY_LEFT, or JUSTIFY_CENTER.
46 .
47 .SH RETURN VALUE
48 The function \fBfield_just\fR returns one of: NO_JUSTIFICATION,
49 JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.
50 .PP
51 The function \fBset_field_just\fR returns one of the following:
52 .TP 5
53 .B E_OK
54 The routine succeeded.
55 .TP 5
56 .B E_SYSTEM_ERROR
57 System error occurred (see \fBerrno\fR).
58 .TP 5
59 .B E_BAD_ARGUMENT
60 Routine detected an incorrect or out-of-range argument.
61 .SH SEE ALSO
62 \fBcurses\fR(3X) and related pages whose names begin "form_" for detailed
63 descriptions of the entry points.
64 .SH NOTES
65 The header file \fB<form.h>\fR automatically includes the header file
66 \fB<curses.h>\fR.
67 .SH PORTABILITY
68 These routines emulate the System V forms library.  They were not supported on
69 Version 7 or BSD versions.
70 .SH AUTHORS
71 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
72 S. Raymond.