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