usr/src/man/man3curses/form_field_just.3curses

   1 '\" te
   2 .\" Copyright 1989 AT&T
   3 .\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
   4 .\" The contents of this file are subject to the terms of the Common Development and Distribution License (the "License").  You may not use this file except in compliance with the License.
   5 .\" You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing.  See the License for the specific language governing permissions and limitations under the License.
   6 .\" When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE.  If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
   7 .TH FORM_FIELD_JUST 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_field_just, set_field_just, field_just \- format the general appearance of
  10 forms
  11 .SH SYNOPSIS
  12 .LP
  13 .nf
  14 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lform\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  15 #include <form.h>
  16
  17
  18
  19 \fBint\fR \fBset_field_just\fR(\fBFIELD *\fR\fIfield\fR, \fBint\fR \fIjustification\fR);
  20 .fi
  21
  22 .LP
  23 .nf
  24 \fBint\fR \fBfield_just\fR(\fBFIELD *\fR\fIfield\fR);
  25 .fi
  26
  27 .SH DESCRIPTION
  28 .sp
  29 .LP
  30 The \fBset_field_just()\fR function sets the justification for \fIfield\fR.
  31 Justification can be one of:
  32 .br
  33 .in +2
  34 \fBNO_JUSTIFICATION\fR
  35 .in -2
  36 .br
  37 .in +2
  38 \fBJUSTIFY_RIGHT\fR
  39 .in -2
  40 .br
  41 .in +2
  42 \fBJUSTIFY_LEFT\fR
  43 .in -2
  44 .br
  45 .in +2
  46 \fBJUSTIFY_CENTER\fR
  47 .in -2
  48 .sp
  49 .LP
  50 The field justification is ignored if \fIfield\fR is a dynamic field.
  51 .sp
  52 .LP
  53 The \fBfield_just()\fR function returns the type of justification assigned to
  54 \fIfield\fR.
  55 .SH RETURN VALUES
  56 .sp
  57 .LP
  58 The \fBfield_just()\fR function returns one of the following:
  59 .br
  60 .in +2
  61 \fBNO_JUSTIFICATION\fR
  62 .in -2
  63 .br
  64 .in +2
  65 \fBJUSTIFY_RIGHT\fR
  66 .in -2
  67 .br
  68 .in +2
  69 \fBJUSTIFY_LEFT\fR
  70 .in -2
  71 .br
  72 .in +2
  73  \fBJUSTIFY_CENTER\fR
  74 .in -2
  75 .sp
  76 .LP
  77 The \fBset_field_just()\fR function returns one of the following:
  78 .sp
  79 .ne 2
  80 .na
  81 \fBE_OK\fR
  82 .ad
  83 .RS 18n
  84 The function returned successfully.
  85 .RE
  86
  87 .sp
  88 .ne 2
  89 .na
  90 \fBE_SYSTEM_ERROR\fR
  91 .ad
  92 .RS 18n
  93 System error.
  94 .RE
  95
  96 .sp
  97 .ne 2
  98 .na
  99 \fBE_BAD_ARGUMENT\fR
 100 .ad
 101 .RS 18n
 102 An argument is incorrect.
 103 .RE
 104
 105 .SH ATTRIBUTES
 106 .sp
 107 .LP
 108 See \fBattributes\fR(5) for descriptions of the following attributes:
 109 .sp
 110
 111 .sp
 112 .TS
 113 box;
 114 c | c
 115 l | l .
 116 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 117 _
 118 MT-Level        Unsafe
 119 .TE
 120
 121 .SH SEE ALSO
 122 .sp
 123 .LP
 124 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
 125 .SH NOTES
 126 .sp
 127 .LP
 128 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 129 \fB<curses.h>\fR\&.