usr/src/man/man3curses/form_win.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_WIN 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_win, set_form_win, set_form_sub, form_sub, scale_form \- forms window and
  10 subwindow association routines
  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 \fBint\fR \fBset_form_win\fR(\fBFORM *\fR\fIform\fR, \fBWINDOW *\fR\fIwin\fR);
  18 .fi
  19
  20 .LP
  21 .nf
  22 \fBWINDOW *\fR\fBform_win\fR(\fBFORM *\fR\fIform\fR);
  23 .fi
  24
  25 .LP
  26 .nf
  27 \fBint\fR \fBset_form_sub\fR(\fBFORM *\fR\fIform\fR, \fBWINDOW *\fR\fIsub\fR);
  28 .fi
  29
  30 .LP
  31 .nf
  32 \fBWINDOW *\fR\fBform_sub\fR(\fBFORM *\fR\fIform\fR);
  33 .fi
  34
  35 .LP
  36 .nf
  37 \fBint\fR \fBscale_form\fR(\fBFORM *\fR\fIform\fR, \fBint *\fR\fIrows\fR, \fBint *\fR\fIcols\fR);
  38 .fi
  39
  40 .SH DESCRIPTION
  41 .sp
  42 .LP
  43 \fBset_form_win()\fR sets the window of \fIform\fR to \fIwin\fR.
  44 \fBform_win()\fR returns a pointer to the window associated with
  45 \fIform\fR.\fBset_form_sub()\fR sets the subwindow of \fIform\fR to \fIsub\fR.
  46 \fBform_sub()\fR returns a pointer to the subwindow associated with
  47 \fIform\fR.\fBscale_form()\fR returns the smallest window size necessary for
  48 the subwindow of \fIform\fR. \fIrows\fR and \fIcols\fR are pointers to the
  49 locations used to return the number of rows and columns for the form.
  50 .SH RETURN VALUES
  51 .sp
  52 .LP
  53 Routines that return pointers always return \fINULL\fR on error. Routines that
  54 return an integer return one of the following:
  55 .sp
  56 .ne 2
  57 .na
  58 \fBE_OK\fR
  59 .ad
  60 .RS 19n
  61 The function returnedsuccessfully.
  62 .RE
  63
  64 .sp
  65 .ne 2
  66 .na
  67 \fBE_SYSTEM_ERROR\fR
  68 .ad
  69 .RS 19n
  70 System error.
  71 .RE
  72
  73 .sp
  74 .ne 2
  75 .na
  76 \fBE_BAD_ARGUMENT\fR
  77 .ad
  78 .RS 19n
  79 An argument is incorrect.
  80 .RE
  81
  82 .sp
  83 .ne 2
  84 .na
  85 \fBE_NOT_CONNECTED\fR
  86 .ad
  87 .RS 19n
  88 The field is not connected to a form.
  89 .RE
  90
  91 .sp
  92 .ne 2
  93 .na
  94 \fBE_POSTED\fR
  95 .ad
  96 .RS 19n
  97 The form is posted.
  98 .RE
  99
 100 .SH ATTRIBUTES
 101 .sp
 102 .LP
 103 See \fBattributes\fR(5) for descriptions of the following attributes:
 104 .sp
 105
 106 .sp
 107 .TS
 108 box;
 109 c | c
 110 l | l .
 111 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 112 _
 113 MT-Level        Unsafe
 114 .TE
 115
 116 .SH SEE ALSO
 117 .sp
 118 .LP
 119 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
 120 .SH NOTES
 121 .sp
 122 .LP
 123 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 124 \fB<curses.h>\fR\&.