<!--
****************************************************************************
- * Copyright (c) 1998-2010,2015 Free Software Foundation, Inc. *
+ * Copyright (c) 1998-2015,2016 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 *
* sale, use or other dealings in this Software without prior written *
* authorization. *
****************************************************************************
- * @Id: form_driver.3x,v 1.25 2015/12/05 21:06:26 tom Exp @
+ * @Id: form_driver.3x,v 1.26 2016/12/04 01:01:17 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<STRONG>o</STRONG> The input is a form navigation request. Navigation
request codes are constants defined in <STRONG><form.h></STRONG>, which
are distinct from the key- and character codes
- returned by <STRONG><A HREF="wgetch.3x.html">wgetch(3x)</A></STRONG>.
+ returned by <STRONG><A HREF="curs_getch.3x.html">wgetch(3x)</A></STRONG>.
<STRONG>o</STRONG> The input is a printable character. Printable charac-
ters (which must be positive, less than 256) are
</PRE><H3><a name="h3-form_driver_w">form_driver_w</a></H3><PRE>
This extension simplifies the use of the forms library
using wide characters. The input is either a key code (a
- request) or a wide character returned by <STRONG><A HREF="get_wch.3x.html">get_wch(3x)</A></STRONG>. The
+ request) or a wide character returned by <STRONG><A HREF="curs_get_wch.3x.html">get_wch(3x)</A></STRONG>. The
type must be passed as well, to enable the library to
determine whether the parameter is a wide character or a
request.
that request is executed.
+</PRE><H3><a name="h3-Field-validation">Field validation</a></H3><PRE>
+ The form library makes updates to the window associated
+ with form fields rather than directly to the field buf-
+ fers.
+
+ The form driver provides low-level control over updates to
+ the form fields. The form driver also provides for vali-
+ dating modified fields to ensure that the contents meet
+ whatever constraints an application may attach using
+ <STRONG>set_field_type</STRONG>.
+
+ You can validate a field without making any changes to it
+ using <STRONG>REQ_VALIDATION</STRONG>. The form driver also validates a
+ field in these cases:
+
+ <STRONG>o</STRONG> a call to <STRONG>set_current_field</STRONG> attempts to move to a dif-
+ ferent field.
+
+ <STRONG>o</STRONG> a call to <STRONG>set_current_page</STRONG> attempts to move to a dif-
+ ferent page of the form.
+
+ <STRONG>o</STRONG> a request attempts to move to a different field.
+
+ <STRONG>o</STRONG> a request attempts to move to a different page of the
+ form.
+
+ In each case, the move fails if the field is invalid.
+
+ If the modified field is valid, the form driver copies the
+ modified data from the window associated with the field to
+ the field buffer.
+
+
</PRE><H3><a name="h3-Mouse-handling">Mouse handling</a></H3><PRE>
- If the second argument is the KEY_MOUSE special key, the
+ If the second argument is the KEY_MOUSE special key, the
associated mouse event is translated into one of the above
- pre-defined requests. Currently only clicks in the user
- window (e.g., inside the form display area or the decora-
+ pre-defined requests. Currently only clicks in the user
+ window (e.g., inside the form display area or the decora-
tion window) are handled.
If you click above the display region of the form:
a REQ_LAST_FIELD is generated for a triple-click.
- If you click at an field inside the display area of the
+ If you click at an field inside the display area of the
form:
<STRONG>o</STRONG> the form cursor is positioned to that field.
- <STRONG>o</STRONG> If you double-click a field, the form cursor is
- positioned to that field and <STRONG>E_UNKNOWN_COMMAND</STRONG> is
+ <STRONG>o</STRONG> If you double-click a field, the form cursor is
+ positioned to that field and <STRONG>E_UNKNOWN_COMMAND</STRONG> is
returned. This return value makes sense, because a
- double click usually means that an field-specific
- action should be returned. It is exactly the pur-
- pose of this return value to signal that an appli-
+ double click usually means that an field-specific
+ action should be returned. It is exactly the pur-
+ pose of this return value to signal that an appli-
cation specific command should be executed.
- <STRONG>o</STRONG> If a translation into a request was done,
+ <STRONG>o</STRONG> If a translation into a request was done,
<STRONG>form_driver</STRONG> returns the result of this request.
- If you clicked outside the user window or the mouse event
- could not be translated into a form request an
+ If you clicked outside the user window or the mouse event
+ could not be translated into a form request an
<STRONG>E_REQUEST_DENIED</STRONG> is returned.
</PRE><H3><a name="h3-Application-defined-commands">Application-defined commands</a></H3><PRE>
If the second argument is neither printable nor one of the
- above pre-defined form requests, the driver assumes it is
+ above pre-defined form requests, the driver assumes it is
an application-specific command and returns <STRONG>E_UNKNOWN_COM-</STRONG>
<STRONG>MAND</STRONG>. Application-defined commands should be defined rel-
- ative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of these pre-
+ ative to <STRONG>MAX_COMMAND</STRONG>, the maximum value of these pre-
defined requests.
<STRONG>E_OK</STRONG> The routine succeeded.
<STRONG>E_BAD_ARGUMENT</STRONG>
- Routine detected an incorrect or out-of-range argu-
+ Routine detected an incorrect or out-of-range argu-
ment.
<STRONG>E_BAD_STATE</STRONG>
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_variables.3x.html">form_variables(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">curs_getch(3x)</A></STRONG>.
+ <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>, <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>,
+ <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>, <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>, <STRONG>form_vari-</STRONG>
+ <STRONG><A HREF="form_variables.3x.html">ables(3x)</A></STRONG>, <STRONG><A HREF="curs_getch.3x.html">getch(3x)</A></STRONG>.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- These routines emulate the System V forms library. They
+ These routines emulate the System V forms library. They
were not supported on Version 7 or BSD versions.
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
- Juergen Pfeifer. Manual pages and adaptation for new
+ Juergen Pfeifer. Manual pages and adaptation for new
curses by Eric S. Raymond.
<li><a href="#h3-form_driver">form_driver</a></li>
<li><a href="#h3-form_driver_w">form_driver_w</a></li>
<li><a href="#h3-Form-driver-requests">Form-driver requests</a></li>
+<li><a href="#h3-Field-validation">Field validation</a></li>
<li><a href="#h3-Mouse-handling">Mouse handling</a></li>
<li><a href="#h3-Application-defined-commands">Application-defined commands</a></li>
</ul>
projects / ncurses.git / blobdiff