ncurses 4.1
[ncurses.git] / man / form_field_just.3x
1 '\" t
2 .TH form_field_just 3X ""
3 .SH NAME
4 \fBform_field_just\fR - retrieve field characteristics
5 .SH SYNOPSIS
6 \fB#include <form.h>\fR
7 .br
8 int set_field_just(FIELD *field, int justification);
9 .br
10 int field_just(const FIELD *field);
11 .br
12 .SH DESCRIPTION
13 The function \fBset_field_just\fR sets the justification attribute of
14 a field; \fBfield_just\fR returns a field's justification attribute.
15 The attribute may be one of NO_JUSTIFICATION, JUSTIFY_RIGHT,
16 JUSTIFY_LEFT, or JUSTIFY_CENTER.
17
18 .SH RETURN VALUE
19 The function \fBfield_just\fR returns one of: NO_JUSTIFICATION,
20 JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.
21
22 The function \fBset_field_just\fR return one of the following:
23 .TP 5
24 \fBE_OK\fR
25 The routine succeeded.
26 .TP 5
27 \fBE_SYSTEM_ERROR\fR
28 System error occurred (see \fBerrno\fR).
29 .TP 5
30 \fBE_BAD_ARGUMENT\fR
31 Routine detected an incorrect or out-of-range argument.
32 .SH SEE ALSO
33 \fBcurses\fR(3X) and 3X pages whose names begin "form_" for detailed
34 descriptions of the entry points.
35 .SH NOTES
36 The header file \fB<form.h>\fR automatically includes the header file
37 \fB<curses.h>\fR.
38 .SH PORTABILITY
39 These routines emulate the System V forms library.  They were not supported on
40 Version 7 or BSD versions.
41 .SH AUTHORS
42 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
43 S. Raymond.
44 .\"#
45 .\"# The following sets edit modes for GNU EMACS
46 .\"# Local Variables:
47 .\"# mode:nroff
48 .\"# fill-column:79
49 .\"# End: