lib/libform/form_field_just.3

   1 '\" t
   2 .\" $OpenBSD: form_field_just.3,v 1.9 2010/01/12 23:22:07 nicm Exp $
   3 .\"
   4 .\"***************************************************************************
   5 .\" Copyright (c) 1998-2003,2006 Free Software Foundation, Inc.              *
   6 .\"                                                                          *
   7 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   8 .\" copy of this software and associated documentation files (the            *
   9 .\" "Software"), to deal in the Software without restriction, including      *
  10 .\" without limitation the rights to use, copy, modify, merge, publish,      *
  11 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  12 .\" copies of the Software, and to permit persons to whom the Software is    *
  13 .\" furnished to do so, subject to the following conditions:                 *
  14 .\"                                                                          *
  15 .\" The above copyright notice and this permission notice shall be included  *
  16 .\" in all copies or substantial portions of the Software.                   *
  17 .\"                                                                          *
  18 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  19 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  20 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  21 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  22 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  23 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  24 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  25 .\"                                                                          *
  26 .\" Except as contained in this notice, the name(s) of the above copyright   *
  27 .\" holders shall not be used in advertising or otherwise to promote the     *
  28 .\" sale, use or other dealings in this Software without prior written       *
  29 .\" authorization.                                                           *
  30 .\"***************************************************************************
  31 .\"
  32 .\" $Id: form_field_just.3,v 1.9 2010/01/12 23:22:07 nicm Exp $
  33 .TH form_field_just 3 ""
  34 .SH NAME
  35 \fBform_field_just\fR - retrieve field characteristics
  36 .SH SYNOPSIS
  37 \fB#include <form.h>\fR
  38 .br
  39 int set_field_just(FIELD *field, int justification);
  40 .br
  41 int field_just(const FIELD *field);
  42 .br
  43 .SH DESCRIPTION
  44 The function \fBset_field_just\fR sets the justification attribute of
  45 a field; \fBfield_just\fR returns a field's justification attribute.
  46 The attribute may be one of NO_JUSTIFICATION, JUSTIFY_RIGHT,
  47 JUSTIFY_LEFT, or JUSTIFY_CENTER.
  48 .
  49 .SH RETURN VALUE
  50 The function \fBfield_just\fR returns one of: NO_JUSTIFICATION,
  51 JUSTIFY_RIGHT, JUSTIFY_LEFT, or JUSTIFY_CENTER.
  52 .PP
  53 The function \fBset_field_just\fR returns one of the following:
  54 .TP 5
  55 .B E_OK
  56 The routine succeeded.
  57 .TP 5
  58 .B E_SYSTEM_ERROR
  59 System error occurred (see \fBerrno\fR).
  60 .TP 5
  61 .B E_BAD_ARGUMENT
  62 Routine detected an incorrect or out-of-range argument.
  63 .SH SEE ALSO
  64 \fBcurses\fR(3) and related pages whose names begin "form_" for detailed
  65 descriptions of the entry points.
  66 .SH NOTES
  67 The header file \fB<form.h>\fR automatically includes the header file
  68 \fB<curses.h>\fR.
  69 .SH PORTABILITY
  70 These routines emulate the System V forms library.  They were not supported on
  71 Version 7 or BSD versions.
  72 .SH AUTHORS
  73 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
  74 S. Raymond.
  75 .\"#
  76 .\"# The following sets edit modes for GNU EMACS
  77 .\"# Local Variables:
  78 .\"# mode:nroff
  79 .\"# fill-column:79
  80 .\"# End: