man/form_field_just.3x

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