1.\" $NetBSD: form_field_just.3,v 1.4 2002/02/20 11:30:58 wiz Exp $ 2.\" 3.\" Copyright (c) 2001 4.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au 5.\" 6.\" This code is donated to The NetBSD Foundation by the author. 7.\" 8.\" Redistribution and use in source and binary forms, with or without 9.\" modification, are permitted provided that the following conditions 10.\" are met: 11.\" 1. Redistributions of source code must retain the above copyright 12.\" notice, this list of conditions and the following disclaimer. 13.\" 2. Redistributions in binary form must reproduce the above copyright 14.\" notice, this list of conditions and the following disclaimer in the 15.\" documentation and/or other materials provided with the distribution. 16.\" 3. The name of the Author may not be used to endorse or promote 17.\" products derived from this software without specific prior written 18.\" permission. 19.\" 20.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30.\" SUCH DAMAGE. 31.\" 32.Dd January 1, 2001 33.Dt FORMS 3 34.Os 35.Sh NAME 36.Nm field_just , 37.Nm set_field_just 38.Nd form library 39.Sh LIBRARY 40.Lb libform 41.Sh SYNOPSIS 42.Fd #include \*[Lt]form.h\*[Gt] 43.Ft int 44.Fn field_just "FIELD *field" 45.Ft int 46.Fn set_field_just "FIELD *field, int justification" 47.Sh DESCRIPTION 48Field justification is only applied to static fields, a dynamic field 49will not be justified. The default justification for a field is 50NO_JUSTIFICATION. The 51.Fn field_just 52will return the current justification value of the given field and the 53justification may be set by calling the 54.Fn set_field_just 55function. 56.Sh PARAMETERS 57The following are the valid justifications for a field: 58.Pp 59.Bl -tag -width NO_JUSTIFICATION -compact 60.It NO_JUSTIFICATION 61No justification is to be applied to the field. In practice, this is 62the same as JUSTIFY_LEFT. 63.It JUSTIFY_RIGHT 64The field will be right justified. That is, the end of each line will 65be butted up against the right hand side of the field. 66.It JUSTIFY_LEFT 67The field will be left justified. That is, the start of each line 68will be butted up against the left hand side of the field. 69.It JUSTIFY_CENTER 70The field will be centre justified, padding will be applied to either 71end of the line to make the line centred in the field. 72.El 73.Sh RETURN VALUES 74Functions returning pointers will return NULL if an error is detected. 75The functions that return an int will return one of the following error 76values: 77.Pp 78.Bl -tag -width E_UNKNOWN_COMMAND -compact 79.It Er E_OK 80The function was successful. 81.It Er E_CURRENT 82The field specified is the currently active one on the form. 83.It Er E_BAD_ARGUMENT 84A bad argument was passed to the function. 85.El 86.Sh SEE ALSO 87.Xr curses 3 , 88.Xr forms 3 89.Sh NOTES 90The header 91.Pa \*[Lt]form.h\*[Gt] 92automatically includes both 93.Pa \*[Lt]curses.h\*[Gt] 94and 95.Pa \*[Lt]eti.h\*[Gt] . 96