X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fform_driver.3x.html;fp=doc%2Fhtml%2Fman%2Fform_driver.3x.html;h=74c3c0b7d11b30920ef096ad3d3e3959743c38e2;hp=a029ea21c6ffd83799256a741ce7fc1ee58f12f4;hb=1dd25cc0259e0683290fe889707b04979b5fda0a;hpb=ee27d238caeccd1ed781a92957afbdb890e1e88f diff --git a/doc/html/man/form_driver.3x.html b/doc/html/man/form_driver.3x.html index a029ea21..74c3c0b7 100644 --- a/doc/html/man/form_driver.3x.html +++ b/doc/html/man/form_driver.3x.html @@ -1,6 +1,6 @@ @@ -156,11 +156,44 @@ that request is executed. +

Field validation

+       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
+       set_field_type.
+
+       You can validate a field without making any changes to  it
+       using  REQ_VALIDATION.   The  form driver also validates a
+       field in these cases:
+
+       o   a call to set_current_field attempts to move to a dif-
+           ferent field.
+
+       o   a  call to set_current_page attempts to move to a dif-
+           ferent page of the form.
+
+       o   a request attempts to move to a different field.
+
+       o   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.
+
+

Mouse handling

-       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:
@@ -179,33 +212,33 @@
 
           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:
 
           o   the form cursor is positioned to that field.
 
-          o   If  you  double-click  a  field, the form cursor is
-              positioned to that field and  E_UNKNOWN_COMMAND  is
+          o   If you double-click a field,  the  form  cursor  is
+              positioned  to  that field and E_UNKNOWN_COMMAND 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.
 
-          o   If   a   translation   into  a  request  was  done,
+          o   If  a  translation  into  a   request   was   done,
               form_driver 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
        E_REQUEST_DENIED is returned.

Application-defined commands

        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 E_UNKNOWN_COM-
        MAND.  Application-defined commands should be defined rel-
-       ative to MAX_COMMAND, the  maximum  value  of  these  pre-
+       ative  to  MAX_COMMAND,  the  maximum  value of these pre-
        defined requests.
 
 
@@ -215,7 +248,7 @@
        E_OK The routine succeeded.
 
        E_BAD_ARGUMENT
-            Routine  detected  an incorrect or out-of-range argu-
+            Routine detected an incorrect or  out-of-range  argu-
             ment.
 
        E_BAD_STATE
@@ -239,7 +272,9 @@

SEE ALSO

-       curses(3x), form(3x), form_variables(3x), curs_getch(3x).
+       curses(3x),        form(3x),        form_field_buffer(3x),
+       form_field_validation(3x),  form_fieldtype(3x), form_vari-
+       ables(3x), curs_getch(3x).

NOTES

@@ -248,12 +283,12 @@

PORTABILITY

-       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.

AUTHORS

-       Juergen  Pfeifer.   Manual  pages  and  adaptation for new
+       Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
        curses by Eric S. Raymond.
 
 
@@ -269,6 +304,7 @@
 
  • form_driver
    • 
 
  • form_driver_w
    • 
 
  • Form-driver requests
    • 
+
  • Field validation
    • 
 
  • Mouse handling
    • 
 
  • Application-defined commands
    •