ncurses 5.6 - patch 20080621
[ncurses.git] / doc / html / man / form.3x.html
index a7b1513fb025d0f6c924b9824880d2f45df5204a..9cf621cee057cdaedcf6081e3e2f818cff1ba908 100644 (file)
@@ -2,7 +2,7 @@
 <!-- 
   * t
   ****************************************************************************
 <!-- 
   * t
   ****************************************************************************
-  * Copyright (c) 1998,2002 Free Software Foundation, Inc.                   *
+  * Copyright (c) 1998-2006,2008 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            *
@@ -28,7 +28,7 @@
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
   * sale, use or other dealings in this Software without prior written       *
   * authorization.                                                           *
   ****************************************************************************
-  * @Id: form.3x,v 1.15 2002/01/19 22:48:05 tom Exp @
+  * @Id: form.3x,v 1.21 2008/04/26 17:11:52 tom Exp @
 -->
 <HTML>
 <HEAD>
 -->
 <HTML>
 <HEAD>
@@ -70,7 +70,6 @@
        before using any of these  functions.   To  use  the  <STRONG>form</STRONG>
        library, link with the options <STRONG>-lform</STRONG> <STRONG>-lcurses</STRONG>.
 
        before using any of these  functions.   To  use  the  <STRONG>form</STRONG>
        library, link with the options <STRONG>-lform</STRONG> <STRONG>-lcurses</STRONG>.
 
-
    <STRONG>Current</STRONG> <STRONG>Default</STRONG> <STRONG>Values</STRONG> <STRONG>for</STRONG> <STRONG>Field</STRONG> <STRONG>Attributes</STRONG>
        The  <STRONG>form</STRONG>  library  maintains  a  default  value for field
        attributes.  You can get or set this  default  by  calling
    <STRONG>Current</STRONG> <STRONG>Default</STRONG> <STRONG>Values</STRONG> <STRONG>for</STRONG> <STRONG>Field</STRONG> <STRONG>Attributes</STRONG>
        The  <STRONG>form</STRONG>  library  maintains  a  default  value for field
        attributes.  You can get or set this  default  by  calling
        affects  future  field  creations, but does not change the
        rendering of fields already created.
 
        affects  future  field  creations, but does not change the
        rendering of fields already created.
 
-
    <STRONG>Routine</STRONG> <STRONG>Name</STRONG> <STRONG>Index</STRONG>
        The following table lists each <STRONG>form</STRONG> routine and  the  name
        of the manual page on which it is described.
 
    <STRONG>Routine</STRONG> <STRONG>Name</STRONG> <STRONG>Index</STRONG>
        The following table lists each <STRONG>form</STRONG> routine and  the  name
        of the manual page on which it is described.
 
-
        <STRONG>curses</STRONG> Routine Name    Manual Page Name
        -------------------------------------------------
        current_field          <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
        data_ahead             <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG>
        data_behind            <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG>
        dup_field              <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
        <STRONG>curses</STRONG> Routine Name    Manual Page Name
        -------------------------------------------------
        current_field          <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
        data_ahead             <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG>
        data_behind            <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG>
        dup_field              <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
-       dynamic_fieldinfo      <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
+       dynamic_field_info     <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
        field_arg              <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
        field_back             <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
        field_buffer           <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
        field_arg              <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
        field_back             <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
        field_buffer           <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
        form_driver            <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
        form_fields            <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
        form_init              <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
        form_driver            <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
        form_fields            <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
        form_init              <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
-
        form_opts              <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
        form_opts_off          <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
        form_opts_on           <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
        form_opts              <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
        form_opts_off          <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
        form_opts_on           <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
+
        form_page              <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
        form_request_by_name   <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG>
        form_request_name      <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG>
        form_page              <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
        form_request_by_name   <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG>
        form_request_name      <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG>
        form_userptr           <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
        form_win               <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
        free_field             <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
        form_userptr           <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
        form_win               <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
        free_field             <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
+       free_fieldtype         <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
        free_form              <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
        link_field             <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
        link_fieldtype         <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
        move_field             <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
        new_field              <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
        free_form              <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
        link_field             <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
        link_fieldtype         <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
        move_field             <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
        new_field              <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
+       new_fieldtype          <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
        new_form               <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
        new_page               <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
        pos_form_cursor        <STRONG><A HREF="form_cursor.3x.html">form_cursor(3x)</A></STRONG>
        new_form               <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
        new_page               <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
        pos_form_cursor        <STRONG><A HREF="form_cursor.3x.html">form_cursor(3x)</A></STRONG>
 
 </PRE>
 <H2>RETURN VALUE</H2><PRE>
 
 </PRE>
 <H2>RETURN VALUE</H2><PRE>
-       Routines  that return pointers return <STRONG>NULL</STRONG> on error.  Rou-
-       tines that return an integer return one of  the  following
-       error codes:
+       Routines  that  return  pointers return <STRONG>NULL</STRONG> on error, and
+       set errno to  the  corresponding  error-code  returned  by
+       functions  returning  an integer.  Routines that return an
+       integer return one of the following error codes:
 
        <STRONG>E_OK</STRONG> The routine succeeded.
 
 
        <STRONG>E_OK</STRONG> The routine succeeded.
 
-       <STRONG>E_CONNECTED</STRONG>
-            The field is already connected to a form.
-
-       <STRONG>E_SYSTEM_ERROR</STRONG>
-            System error occurred (see <STRONG>errno</STRONG>).
-
        <STRONG>E_BAD_ARGUMENT</STRONG>
        <STRONG>E_BAD_ARGUMENT</STRONG>
-            Routine  detected  an incorrect or out-of-range argu-
+            Routine detected an incorrect or  out-of-range  argu-
             ment.
 
             ment.
 
-       <STRONG>E_POSTED</STRONG>
-            The form is already posted.
-
        <STRONG>E_BAD_STATE</STRONG>
             Routine was called from an initialization or termina-
             tion function.
 
        <STRONG>E_BAD_STATE</STRONG>
             Routine was called from an initialization or termina-
             tion function.
 
-       <STRONG>E_NO_ROOM</STRONG>
-            Form is too large for its window.
-
-       <STRONG>E_NOT_POSTED</STRONG>
-            The form has not been posted.
-
-       <STRONG>E_UNKNOWN_COMMAND</STRONG>
-            The form driver code saw an unknown request code.
+       <STRONG>E_CONNECTED</STRONG>
+            The field is already connected to a form.
 
        <STRONG>E_INVALID_FIELD</STRONG>
             Contents of a field are not valid.
 
        <STRONG>E_INVALID_FIELD</STRONG>
             Contents of a field are not valid.
        <STRONG>E_NOT_CONNECTED</STRONG>
             No fields are connected to the form.
 
        <STRONG>E_NOT_CONNECTED</STRONG>
             No fields are connected to the form.
 
+       <STRONG>E_NOT_POSTED</STRONG>
+            The form has not been posted.
+
+       <STRONG>E_NO_ROOM</STRONG>
+            Form is too large for its window.
+
+       <STRONG>E_POSTED</STRONG>
+            The form is already posted.
+
        <STRONG>E_REQUEST_DENIED</STRONG>
             The form driver could not process the request.
 
        <STRONG>E_REQUEST_DENIED</STRONG>
             The form driver could not process the request.
 
+       <STRONG>E_SYSTEM_ERROR</STRONG>
+            System error occurred (see <STRONG>errno</STRONG>).
+
+       <STRONG>E_UNKNOWN_COMMAND</STRONG>
+            The form driver code saw an unknown request code.
+
 
 </PRE>
 <H2>SEE ALSO</H2><PRE>
 
 </PRE>
 <H2>SEE ALSO</H2><PRE>
        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
        files <STRONG>&lt;curses.h&gt;</STRONG> and <STRONG>&lt;eti.h&gt;</STRONG>.
 
        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
        files <STRONG>&lt;curses.h&gt;</STRONG> and <STRONG>&lt;eti.h&gt;</STRONG>.
 
-       In  your  library  list,  libform.a should be before libn-
+       In your library list, libform.a  should  be  before  libn-
        curses.a; that is, you want to say `-lform -lncurses', not
        curses.a; that is, you want to say `-lform -lncurses', not
-       the  other  way  around (which would give you a link error
-       using GNU <STRONG><A HREF="ld.1.html">ld(1)</A></STRONG> and many other linkers).
+       the other way around (which would give you  a  link  error
+       using most linkers).
 
 
 </PRE>
 <H2>PORTABILITY</H2><PRE>
 
 
 </PRE>
 <H2>PORTABILITY</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>AUTHORS</H2><PRE>
        were not supported on Version 7 or BSD versions.
 
 
 </PRE>
 <H2>AUTHORS</H2><PRE>
-       Juergen  Pfeifer.  Manual pages and adaptation for ncurses
+       Juergen Pfeifer.  Manual pages and adaptation for  ncurses
        by Eric S. Raymond.
 
 
        by Eric S. Raymond.
 
 
+</PRE>
+<H2>SEE ALSO</H2><PRE>
+       This describes <STRONG>ncurses</STRONG> version 5.6 (patch 20080621).
+
+
 
                                                                <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>
 </PRE>
 
                                                                <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>
 </PRE>