doc/html/man/form.3x.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   * t
   4   ****************************************************************************
   5   * Copyright (c) 1998-2006,2008 Free Software Foundation, Inc.              *
   6   *                                                                          *
   7   * Permission is hereby granted, free of charge, to any person obtaining a  *
   8   * copy of this software and associated documentation files (the            *
   9   * "Software"), to deal in the Software without restriction, including      *
  10   * without limitation the rights to use, copy, modify, merge, publish,      *
  11   * distribute, distribute with modifications, sublicense, and/or sell       *
  12   * copies of the Software, and to permit persons to whom the Software is    *
  13   * furnished to do so, subject to the following conditions:                 *
  14   *                                                                          *
  15   * The above copyright notice and this permission notice shall be included  *
  16   * in all copies or substantial portions of the Software.                   *
  17   *                                                                          *
  18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  25   *                                                                          *
  26   * Except as contained in this notice, the name(s) of the above copyright   *
  27   * holders shall not be used in advertising or otherwise to promote the     *
  28   * sale, use or other dealings in this Software without prior written       *
  29   * authorization.                                                           *
  30   ****************************************************************************
  31   * @Id: form.3x,v 1.22 2008/10/11 20:48:11 tom Exp @
  32 -->
  33 <HTML>
  34 <HEAD>
  35 <TITLE>form 3x</TITLE>
  36 <link rev=made href="mailto:bug-ncurses@gnu.org">
  37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  38 </HEAD>
  39 <BODY>
  40 <H1>form 3x</H1>
  41 <HR>
  42 <PRE>
  43 <!-- Manpage converted by man2html 3.0.1 -->
  44 <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>                                                       <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2>NAME</H2><PRE>
  51        <STRONG>form</STRONG> - curses extension for programming forms
  52
  53
  54 </PRE>
  55 <H2>SYNOPSIS</H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  57
  58
  59 </PRE>
  60 <H2>DESCRIPTION</H2><PRE>
  61        The  <STRONG>form</STRONG> library provides terminal-independent facilities
  62        for composing form screens  on  character-cell  terminals.
  63        The  library  includes:  field  routines, which create and
  64        modify form fields; and form routines, which group  fields
  65        into forms, display forms on the screen, and handle inter-
  66        action with the user.
  67
  68        The <STRONG>form</STRONG> library uses the <STRONG>curses</STRONG> libraries.   To  use  the
  69        <STRONG>form</STRONG> library, link with the options <STRONG>-lform</STRONG> <STRONG>-lcurses</STRONG>.
  70
  71        Your program should set up the locale, e.g.,
  72
  73             <STRONG>setlocale(LC_ALL,</STRONG> <STRONG>"");</STRONG>
  74
  75        so that input/output processing will work.
  76
  77        A  curses  initialization  routine such as <STRONG>initscr</STRONG> must be
  78        called before using any of these functions.
  79
  80    <STRONG>Current</STRONG> <STRONG>Default</STRONG> <STRONG>Values</STRONG> <STRONG>for</STRONG> <STRONG>Field</STRONG> <STRONG>Attributes</STRONG>
  81        The <STRONG>form</STRONG> library  maintains  a  default  value  for  field
  82        attributes.   You  can  get or set this default by calling
  83        the appropriate <STRONG>set_</STRONG> or  retrieval  routine  with  a  <STRONG>NULL</STRONG>
  84        field pointer.  Changing this default with a <STRONG>set_</STRONG> function
  85        affects future field creations, but does  not  change  the
  86        rendering of fields already created.
  87
  88    <STRONG>Routine</STRONG> <STRONG>Name</STRONG> <STRONG>Index</STRONG>
  89        The  following  table lists each <STRONG>form</STRONG> routine and the name
  90        of the manual page on which it is described.
  91
  92        <STRONG>curses</STRONG> Routine Name    Manual Page Name
  93        -------------------------------------------------
  94        current_field          <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
  95        data_ahead             <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG>
  96        data_behind            <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG>
  97        dup_field              <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
  98        dynamic_field_info     <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
  99        field_arg              <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
 100        field_back             <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
 101        field_buffer           <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
 102        field_count            <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
 103        field_fore             <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
 104        field_index            <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
 105        field_info             <STRONG><A HREF="form_field_info.3x.html">form_field_info(3x)</A></STRONG>
 106        field_init             <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
 107        field_just             <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG>
 108        field_opts             <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
 109        field_opts_off         <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
 110        field_opts_on          <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
 111        field_pad              <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
 112        field_status           <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
 113        field_term             <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
 114        field_type             <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
 115
 116        field_userptr          <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG>
 117        form_driver            <STRONG><A HREF="form_driver.3x.html">form_driver(3x)</A></STRONG>
 118        form_fields            <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
 119        form_init              <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
 120        form_opts              <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
 121        form_opts_off          <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
 122        form_opts_on           <STRONG><A HREF="form_opts.3x.html">form_opts(3x)</A></STRONG>
 123        form_page              <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
 124        form_request_by_name   <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG>
 125        form_request_name      <STRONG><A HREF="form_requestname.3x.html">form_requestname(3x)</A></STRONG>
 126        form_sub               <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
 127        form_term              <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
 128        form_userptr           <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
 129        form_win               <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
 130        free_field             <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
 131        free_fieldtype         <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
 132        free_form              <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
 133        link_field             <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
 134        link_fieldtype         <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
 135        move_field             <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
 136        new_field              <STRONG><A HREF="form_field_new.3x.html">form_field_new(3x)</A></STRONG>
 137        new_fieldtype          <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
 138        new_form               <STRONG><A HREF="form_new.3x.html">form_new(3x)</A></STRONG>
 139        new_page               <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
 140        pos_form_cursor        <STRONG><A HREF="form_cursor.3x.html">form_cursor(3x)</A></STRONG>
 141        post_form              <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG>
 142        scale_form             <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
 143        set_current_field      <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
 144        set_field_back         <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
 145        set_field_buffer       <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
 146        set_field_fore         <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
 147        set_field_init         <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
 148        set_field_just         <STRONG><A HREF="form_field_just.3x.html">form_field_just(3x)</A></STRONG>
 149        set_field_opts         <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
 150        set_field_pad          <STRONG><A HREF="form_field_attributes.3x.html">form_field_attributes(3x)</A></STRONG>
 151        set_field_status       <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
 152        set_field_term         <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
 153        set_field_type         <STRONG><A HREF="form_field_validation.3x.html">form_field_validation(3x)</A></STRONG>
 154        set_field_userptr      <STRONG><A HREF="form_field_userptr.3x.html">form_field_userptr(3x)</A></STRONG>
 155        set_fieldtype_arg      <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
 156        set_fieldtype_choice   <STRONG><A HREF="form_fieldtype.3x.html">form_fieldtype(3x)</A></STRONG>
 157        set_form_fields        <STRONG><A HREF="form_field.3x.html">form_field(3x)</A></STRONG>
 158        set_form_init          <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
 159        set_form_opts          <STRONG><A HREF="form_field_opts.3x.html">form_field_opts(3x)</A></STRONG>
 160        set_form_page          <STRONG><A HREF="form_page.3x.html">form_page(3x)</A></STRONG>
 161        set_form_sub           <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
 162        set_form_term          <STRONG><A HREF="form_hook.3x.html">form_hook(3x)</A></STRONG>
 163        set_form_userptr       <STRONG><A HREF="form_userptr.3x.html">form_userptr(3x)</A></STRONG>
 164        set_form_win           <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
 165        set_max_field          <STRONG><A HREF="form_field_buffer.3x.html">form_field_buffer(3x)</A></STRONG>
 166        set_new_page           <STRONG><A HREF="form_new_page.3x.html">form_new_page(3x)</A></STRONG>
 167        unpost_form            <STRONG><A HREF="form_post.3x.html">form_post(3x)</A></STRONG>
 168
 169
 170 </PRE>
 171 <H2>RETURN VALUE</H2><PRE>
 172        Routines that return pointers return <STRONG>NULL</STRONG>  on  error,  and
 173        set  errno  to  the  corresponding  error-code returned by
 174        functions returning an integer.  Routines that  return  an
 175        integer return one of the following error codes:
 176
 177        <STRONG>E_OK</STRONG> The routine succeeded.
 178
 179        <STRONG>E_BAD_ARGUMENT</STRONG>
 180             Routine  detected  an incorrect or out-of-range argu-
 181             ment.
 182
 183        <STRONG>E_BAD_STATE</STRONG>
 184             Routine was called from an initialization or termina-
 185             tion function.
 186
 187        <STRONG>E_CONNECTED</STRONG>
 188             The field is already connected to a form.
 189
 190        <STRONG>E_INVALID_FIELD</STRONG>
 191             Contents of a field are not valid.
 192
 193        <STRONG>E_NOT_CONNECTED</STRONG>
 194             No fields are connected to the form.
 195
 196        <STRONG>E_NOT_POSTED</STRONG>
 197             The form has not been posted.
 198
 199        <STRONG>E_NO_ROOM</STRONG>
 200             Form is too large for its window.
 201
 202        <STRONG>E_POSTED</STRONG>
 203             The form is already posted.
 204
 205        <STRONG>E_REQUEST_DENIED</STRONG>
 206             The form driver could not process the request.
 207
 208        <STRONG>E_SYSTEM_ERROR</STRONG>
 209             System error occurred (see <STRONG>errno</STRONG>).
 210
 211        <STRONG>E_UNKNOWN_COMMAND</STRONG>
 212             The form driver code saw an unknown request code.
 213
 214
 215 </PRE>
 216 <H2>SEE ALSO</H2><PRE>
 217        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "form_" for
 218        detailed descriptions of the entry points.
 219
 220
 221 </PRE>
 222 <H2>NOTES</H2><PRE>
 223        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
 224        files <STRONG>&lt;curses.h&gt;</STRONG> and <STRONG>&lt;eti.h&gt;</STRONG>.
 225
 226        In  your  library  list,  libform.a should be before libn-
 227        curses.a; that is, you want to say `-lform -lncurses', not
 228        the  other  way  around (which would give you a link error
 229        using most linkers).
 230
 231
 232 </PRE>
 233 <H2>PORTABILITY</H2><PRE>
 234        These routines emulate the System V forms  library.   They
 235        were not supported on Version 7 or BSD versions.
 236
 237
 238 </PRE>
 239 <H2>AUTHORS</H2><PRE>
 240        Juergen  Pfeifer.  Manual pages and adaptation for ncurses
 241        by Eric S. Raymond.
 242
 243
 244 </PRE>
 245 <H2>SEE ALSO</H2><PRE>
 246        This describes <STRONG>ncurses</STRONG> version 5.6 (patch 20081011).
 247
 248
 249
 250                                                                <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>
 251 </PRE>
 252 <HR>
 253 <ADDRESS>
 254 Man(1) output converted with
 255 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 256 </ADDRESS>
 257 </BODY>
 258 </HTML>