usr/src/man/man3curses/form_hook.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_HOOK 3CURSES "Dec 31, 1996"
   8 .SH NAME
   9 form_hook, set_form_init, form_init, set_form_term, form_term, set_field_init,
  10 field_init, set_field_term, field_term \- assign application-specific routines
  11 for invocation by forms
  12 .SH SYNOPSIS
  13 .LP
  14 .nf
  15 \fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lform\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
  16 #include <form.h>
  17
  18
  19
  20 \fBint\fR \fBset_form_init\fR(\fBFORM *\fR\fIform\fR, \fBvoid (*func)(FORM*)\fR);
  21 .fi
  22
  23 .LP
  24 .nf
  25 \fBvoid\fR \fB(*form_init)\fR(\fBFORM *\fR\fIform\fR);
  26 .fi
  27
  28 .LP
  29 .nf
  30 \fBint\fR \fBset_form_term\fR(\fBFORM *\fR\fIform\fR, \fBvoid (*func)(FORM*)\fR);
  31 .fi
  32
  33 .LP
  34 .nf
  35 \fBvoid\fR \fB(*form_term)\fR(\fBFORM *\fR\fIform\fR);
  36 .fi
  37
  38 .LP
  39 .nf
  40 \fBint\fR \fBset_field_init\fR(\fBFORM *\fR\fIform\fR, \fBvoid (*func)(FORM*)\fR);
  41 .fi
  42
  43 .LP
  44 .nf
  45 \fBvoid\fR \fB(*field_init)\fR(\fBFORM *\fR\fIform\fR);
  46 .fi
  47
  48 .LP
  49 .nf
  50 \fBint\fR \fBset_field_term\fR(\fBFORM *\fR\fIform\fR, \fBvoid (*func)(FORM*)\fR);
  51 .fi
  52
  53 .LP
  54 .nf
  55 \fBvoid\fR \fB(*field_term)\fR(\fBFORM *\fR\fIform\fR);
  56 .fi
  57
  58 .SH DESCRIPTION
  59 .sp
  60 .LP
  61 These routines allow the programmer to assign application specific routines to
  62 be executed automatically at initialization and termination points in the
  63 \fBforms\fR application. The user need not specify any application-defined
  64 initialization or termination routines at all, but they may be helpful for
  65 displaying messages or page numbers and other chores.
  66 .sp
  67 .LP
  68 \fBset_form_init()\fR assigns an application-defined initialization function to
  69 be called when the \fIform\fR is posted and just after a page change.
  70 \fBform_init()\fR returns a pointer to the initialization function, if any.
  71 .sp
  72 .LP
  73 \fBset_form_term()\fR assigns an application-defined function to be called when
  74 the \fIform\fR is unposted and just before a page change. \fBform_term()\fR
  75 returns a pointer to the function, if any.
  76 .sp
  77 .LP
  78 \fBset_field_init()\fR assigns an application-defined function to be called
  79 when the \fIform\fR is posted and just after the current field changes.
  80 \fBfield_init()\fR returns a pointer to the function, if any.
  81 .sp
  82 .LP
  83 \fBset_field_term()\fR assigns an application-defined function to be called
  84 when the \fIform\fR is unposted and just before the current field changes.
  85 \fBfield_term()\fR returns a pointer to the function, if any.
  86 .SH RETURN VALUES
  87 .sp
  88 .LP
  89 Routines that return pointers always return \fINULL\fR on error. Routines that
  90 return an integer return one of the following:
  91 .sp
  92 .ne 2
  93 .na
  94 \fBE_OK\fR
  95 .ad
  96 .RS 18n
  97 The function returned successfully.
  98 .RE
  99
 100 .sp
 101 .ne 2
 102 .na
 103 \fBE_SYSTEM_ERROR\fR
 104 .ad
 105 .RS 18n
 106 System error.
 107 .RE
 108
 109 .SH ATTRIBUTES
 110 .sp
 111 .LP
 112 See \fBattributes\fR(5) for descriptions of the following attributes:
 113 .sp
 114
 115 .sp
 116 .TS
 117 box;
 118 c | c
 119 l | l .
 120 ATTRIBUTE TYPE  ATTRIBUTE VALUE
 121 _
 122 MT-Level        Unsafe
 123 .TE
 124
 125 .SH SEE ALSO
 126 .sp
 127 .LP
 128 \fBcurses\fR(3CURSES), \fBforms\fR(3CURSES), \fBattributes\fR(5)
 129 .SH NOTES
 130 .sp
 131 .LP
 132 The header \fB<form.h>\fR automatically includes the headers  \fB<eti.h>\fR and
 133 \fB<curses.h>\fR\&.