ncurses 5.7 - patch 20110108

[ncurses.git] / man / form_fieldtype.3x

diff --git a/man/form_fieldtype.3x b/man/form_fieldtype.3x
index 979258a2ba976c8e553e67dcade24f762c8c4232..028e9b0befccfcb978bc238693c39e36c045596c 100644 (file)
--- a/man/form_fieldtype.3x
+++ b/man/form_fieldtype.3x
@@ -1,6 +1,6 @@
 '\" t
 .\"***************************************************************************
 '\" t
 .\"***************************************************************************

-.\" Copyright (c) 1998-2002,2003 Free Software Foundation, Inc.              *
+.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc.              *

 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *
 .\"                                                                          *
 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
 .\" copy of this software and associated documentation files (the            *


@@ -27,10 +27,10 @@
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"
 .\" authorization.                                                           *
 .\"***************************************************************************
 .\"

-.\" $Id: form_fieldtype.3x,v 1.12 2003/05/10 20:33:49 jmc Exp $
+.\" $Id: form_fieldtype.3x,v 1.16 2010/12/04 18:40:45 tom Exp $

 .TH form_fieldtype 3X ""
 .SH NAME
 .TH form_fieldtype 3X ""
 .SH NAME

-\fBform_fieldtype\fR - define validation-field types
+\fBform_fieldtype\fR \- define validation-field types

 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br
 .SH SYNOPSIS
 \fB#include <form.h>\fR
 .br


@@ -61,14 +61,14 @@ validity of an entered data string whenever the user attempts to leave a field.
 The (FIELD *) argument is passed in so the validation predicate can see the
 field's buffer, sizes and other attributes; the second argument is an
 argument-block structure, about which more below.
 The (FIELD *) argument is passed in so the validation predicate can see the
 field's buffer, sizes and other attributes; the second argument is an
 argument-block structure, about which more below.

-
+.PP

 You also supply \fBnew_fieldtype\fR with \fIchar_check\fR,
 a function to validate input characters as they are entered; it will be passed
 the character to be checked and a pointer to an argument-block structure.
 You also supply \fBnew_fieldtype\fR with \fIchar_check\fR,
 a function to validate input characters as they are entered; it will be passed
 the character to be checked and a pointer to an argument-block structure.

-
+.PP

 The function \fBfree_fieldtype\fR frees the space allocated for a given
 validation type.
 The function \fBfree_fieldtype\fR frees the space allocated for a given
 validation type.

-
+.PP

 The function \fBset_fieldtype_arg\fR associates three storage-management functions
 with a field type.
 The \fImake_arg\fR function is automatically applied to the
 The function \fBset_fieldtype_arg\fR associates three storage-management functions
 with a field type.
 The \fImake_arg\fR function is automatically applied to the


@@ -82,11 +82,11 @@ the other two are optional, you may supply NULL for them.
 In this case it is assumed
 that \fImake_arg\fR does not allocate memory but simply loads the
 argument into a single scalar value.
 In this case it is assumed
 that \fImake_arg\fR does not allocate memory but simply loads the
 argument into a single scalar value.

-
+.PP

 The function \fBlink_fieldtype\fR creates
 a new field type from the two given types.
 They are connected by an logical 'OR'.
 The function \fBlink_fieldtype\fR creates
 a new field type from the two given types.
 They are connected by an logical 'OR'.

-
+.PP

 The form driver requests \fBREQ_NEXT_CHOICE\fR and \fBREQ_PREV_CHOICE\fR assume
 that the possible values of a field form an ordered set, and provide the forms
 user with a way to move through the set.
 The form driver requests \fBREQ_NEXT_CHOICE\fR and \fBREQ_PREV_CHOICE\fR assume
 that the possible values of a field form an ordered set, and provide the forms
 user with a way to move through the set.


@@ -97,27 +97,40 @@ These functions take the field pointer and an
 argument-block structure as arguments.
 .SH RETURN VALUE
 The pointer-valued routines return NULL on error.
 argument-block structure as arguments.
 .SH RETURN VALUE
 The pointer-valued routines return NULL on error.

-
+They set errno according to their success:
+.TP 5
+.B E_OK
+The routine succeeded.
+.TP 5
+.B E_BAD_ARGUMENT
+Routine detected an incorrect or out-of-range argument.
+.TP 5
+.B E_SYSTEM_ERROR
+System error occurred, e.g., malloc failure.
+.PP

 The integer-valued routines return one of the following codes on
 error:
 .TP 5
 The integer-valued routines return one of the following codes on
 error:
 .TP 5

-\fBE_OK\fR
+.B E_OK

 The routine succeeded.
 .TP 5
 The routine succeeded.
 .TP 5

-\fBE_SYSTEM_ERROR\fR
-System error occurred (see \fBerrno\fR).
-.TP 5
-\fBE_BAD_ARGUMENT\fR
+.B E_BAD_ARGUMENT

 Routine detected an incorrect or out-of-range argument.
 .TP 5
 Routine detected an incorrect or out-of-range argument.
 .TP 5

-\fBE_CONNECTED\fR
+.B E_CONNECTED

 The field is already connected to a form.
 The field is already connected to a form.

+.TP 5
+.B E_CURRENT
+The field is the current field.
+.TP 5
+.B E_SYSTEM_ERROR
+System error occurred (see \fBerrno\fR).

 .SH SEE ALSO
 \fBcurses\fR(3X), \fBform\fR(3X).
 .SH NOTES
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.
 .SH SEE ALSO
 \fBcurses\fR(3X), \fBform\fR(3X).
 .SH NOTES
 The header file \fB<form.h>\fR automatically includes the header file
 \fB<curses.h>\fR.

-
+.PP

 All of the \fB(char *)\fR arguments of these functions should actually be
 \fB(void *)\fR.  The type has been left uncorrected for strict compatibility
 with System V.
 All of the \fB(char *)\fR arguments of these functions should actually be
 \fB(void *)\fR.  The type has been left uncorrected for strict compatibility
 with System V.


@@ -127,9 +140,3 @@ Version 7 or BSD versions.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.
 .SH AUTHORS
 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 S. Raymond.

-.\"#
-.\"# The following sets edit modes for GNU EMACS
-.\"# Local Variables:
-.\"# mode:nroff
-.\"# fill-column:79
-.\"# End: