lib/libform/form_field_just.3

   1 .\"     $NetBSD: form_field_just.3,v 1.9 2004/11/24 12:26:23 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 .In form.h
  43 .Ft int
  44 .Fn field_just "FIELD *field"
  45 .Ft int
  46 .Fn set_field_just "FIELD *field" "int justification"
  47 .Sh DESCRIPTION
  48 Field justification is only applied to static fields, a dynamic field
  49 will not be justified.
  50 The default justification for a field is
  51 NO_JUSTIFICATION.
  52 The
  53 .Fn field_just
  54 will return the current justification value of the given field and the
  55 justification may be set by calling the
  56 .Fn set_field_just
  57 function.
  58 .Sh PARAMETERS
  59 The following are the valid justifications for a field:
  60 .Pp
  61 .Bl -tag -width NO_JUSTIFICATION -compact
  62 .It NO_JUSTIFICATION
  63 No justification is to be applied to the field.
  64 In practice, this is the same as JUSTIFY_LEFT.
  65 .It JUSTIFY_RIGHT
  66 The field will be right justified.
  67 That is, the end of each line will
  68 be butted up against the right hand side of the field.
  69 .It JUSTIFY_LEFT
  70 The field will be left justified.
  71 That is, the start of each line
  72 will be butted up against the left hand side of the field.
  73 .It JUSTIFY_CENTER
  74 The field will be centre justified, padding will be applied to either
  75 end of the line to make the line centred in the field.
  76 .El
  77 .Sh RETURN VALUES
  78 The functions will return one of the following error values:
  79 .Pp
  80 .Bl -tag -width E_UNKNOWN_COMMAND -compact
  81 .It Er E_OK
  82 The function was successful.
  83 .It Er E_CURRENT
  84 The field specified is the currently active one on the form.
  85 .It Er E_BAD_ARGUMENT
  86 A bad argument was passed to the function.
  87 .El
  88 .Sh SEE ALSO
  89 .Xr curses 3 ,
  90 .Xr forms 3
  91 .Sh NOTES
  92 The header
  93 .Aq Pa form.h
  94 automatically includes both
  95 .Aq Pa curses.h
  96 and
  97 .Aq Pa eti.h .