Debian Codegraph @

upstream/debian-unstable/man3/field_just.3form

raw
1 .\"***************************************************************************
2 .\" Copyright 2018-2023,2024 Thomas E. Dickey *
3 .\" Copyright 1998-2010,2015 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.35 2024/03/16 15:35:01 tom Exp $
31 .TH field_just 3FORM 2024-03-16 "ncurses 6.6" "Library calls"
32 .ie \n(.g \{\
33 .ds `` \(lq
34 .ds '' \(rq
35 .\}
36 .el \{\
37 .ie t .ds `` ``
38 .el .ds `` ""
39 .ie t .ds '' ''
40 .el .ds '' ""
41 .\}
42 .SH NAME
43 \fBset_field_just\fP,
44 \fBfield_just\fP \-
45 retrieve field characteristics
46 .SH SYNOPSIS
47 .nf
48 \fB#include <form.h>
49 .PP
50 \fBint set_field_just(FIELD *\fIfield\fP, int \fIjustification\fP);
51 \fBint field_just(const FIELD *\fIfield\fP);
52 .fi
53 .SH DESCRIPTION
54 The function \fBset_field_just\fP sets the justification attribute of
55 a field; \fBfield_just\fP returns a field's justification attribute.
56 The attribute may be one of NO_JUSTIFICATION, JUSTIFY_RIGHT,
57 JUSTIFY_LEFT, or JUSTIFY_CENTER.
58 .
59 .SH RETURN VALUE
60 The function \fBfield_just\fP returns one of: NO_JUSTIFICATION,
61 JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.
62 .PP
63 The function \fBset_field_just\fP returns one of the following:
64 .TP 5
65 .B E_OK
66 The routine succeeded.
67 .TP 5
68 .B E_SYSTEM_ERROR
69 System error occurred (see \fBerrno\fP(3)).
70 .TP 5
71 .B E_BAD_ARGUMENT
72 Routine detected an incorrect or out-of-range argument.
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.
80 .SH SEE ALSO
81 \fB\%ncurses\fP(3NCURSES) and related pages whose names begin \*(``form_\*(''
82 for detailed descriptions of the entry points.