*nix Documentation Project
·  Home
 +   man pages
·  Linux HOWTOs
·  FreeBSD Tips
·  *niX Forums

  man pages->OpenBSD man pages -> form (3)              



NAME    [Toc]    [Back]

       form - curses extension for programming forms

SYNOPSIS    [Toc]    [Back]

       #include <form.h>

DESCRIPTION    [Toc]    [Back]

       The  form library provides terminal-independent facilities
       for composing form screens  on  character-cell  terminals.
       The  library  includes:  field  routines, which create and
       modify form fields; and form routines, which group  fields
       into forms, display forms on the screen, and handle interaction
 with the user.

       The form library uses the curses libraries, and  a  curses
       initialization  routine  such  as  initscr  must be called
       before using any of these  functions.   To  use  the  form
       library, link with the options -lform -lcurses.

   Current Default Values for Field Attributes    [Toc]    [Back]
       The  form  library  maintains  a  default  value for field
       attributes.  You can get or set this  default  by  calling
       the  appropriate  set_  or  retrieval  routine with a NULL
       field pointer.  Changing this default with a set_ function
       affects  future  field  creations, but does not change the
       rendering of fields already created.

   Routine Name Index    [Toc]    [Back]
       The following table lists each form routine and  the  name
       of the manual page on which it is described.

       curses Routine Name    Manual Page Name
       current_field          form_page(3)
       data_ahead             form_data(3)
       data_behind            form_data(3)
       dup_field              form_field_new(3)
       dynamic_fieldinfo      form_field_info(3)
       field_arg              form_field_validation(3)
       field_back             form_field_attributes(3)
       field_buffer           form_field_buffer(3)
       field_count            form_field(3)
       field_fore             form_field_attributes(3)
       field_index            form_page(3)
       field_info             form_field_info(3)
       field_init             form_hook(3)
       field_just             form_field_just(3)
       field_opts             form_field_opts(3)
       field_opts_off         form_field_opts(3)
       field_opts_on          form_field_opts(3)
       field_pad              form_field_attributes(3)
       field_status           form_field_buffer(3)
       field_term             form_hook(3)
       field_type             form_field_validation(3)
       field_userptr          form_field_userptr(3)
       form_driver            form_driver(3)
       form_fields            form_field(3)
       form_init              form_hook(3)
       form_opts              form_opts(3)
       form_opts_off          form_opts(3)
       form_opts_on           form_opts(3)
       form_page              form_page(3)
       form_request_by_name   form_requestname(3)
       form_request_name      form_requestname(3)
       form_sub               form_win(3)
       form_term              form_hook(3)
       form_userptr           form_userptr(3)
       form_win               form_win(3)
       free_field             form_field_new(3)
       free_form              form_new(3)
       link_field             form_field_new(3)
       link_fieldtype         form_fieldtype(3)
       move_field             form_field(3)
       new_field              form_field_new(3)
       new_form               form_new(3)
       new_page               form_new_page(3)
       pos_form_cursor        form_cursor(3)
       post_form              form_post(3)
       scale_form             form_win(3)
       set_current_field      form_page(3)
       set_field_back         form_field_attributes(3)
       set_field_buffer       form_field_buffer(3)
       set_field_fore         form_field_attributes(3)
       set_field_init         form_hook(3)
       set_field_just         form_field_just(3)
       set_field_opts         form_field_opts(3)
       set_field_pad          form_field_attributes(3)
       set_field_status       form_field_buffer(3)
       set_field_term         form_hook(3)
       set_field_type         form_field_validation(3)
       set_field_userptr      form_field_userptr(3)
       set_fieldtype_arg      form_fieldtype(3)
       set_fieldtype_choice   form_fieldtype(3)
       set_form_fields        form_field(3)
       set_form_init          form_hook(3)
       set_form_opts          form_field_opts(3)
       set_form_page          form_page(3)
       set_form_sub           form_win(3)
       set_form_term          form_hook(3)
       set_form_userptr       form_userptr(3)
       set_form_win           form_win(3)
       set_max_field          form_field_buffer(3)
       set_new_page           form_new_page(3)
       unpost_form            form_post(3)

RETURN VALUE    [Toc]    [Back]

       Routines  that return pointers return NULL on error.  Routines
 that return an integer return one of  the  following
       error codes:

       E_OK The routine succeeded.

       E_CONNECTED    [Toc]    [Back]
            The field is already connected to a form.

       E_SYSTEM_ERROR    [Toc]    [Back]
            System error occurred (see errno).

       E_BAD_ARGUMENT    [Toc]    [Back]
            Routine  detected  an incorrect or out-of-range argument.

       E_POSTED    [Toc]    [Back]
            The form is already posted.

       E_BAD_STATE    [Toc]    [Back]
            Routine was called from an initialization or termination

       E_NO_ROOM    [Toc]    [Back]
            Form is too large for its window.

       E_NOT_POSTED    [Toc]    [Back]
            The form has not been posted.

       E_UNKNOWN_COMMAND    [Toc]    [Back]
            The form driver code saw an unknown request code.

       E_INVALID_FIELD    [Toc]    [Back]
            Contents of a field are not valid.

       E_NOT_CONNECTED    [Toc]    [Back]
            No fields are connected to the form.

       E_REQUEST_DENIED    [Toc]    [Back]
            The form driver could not process the request.

SEE ALSO    [Toc]    [Back]

       curses(3)  and  3 pages whose names begin with "form_" for
       detailed descriptions of the entry points.

NOTES    [Toc]    [Back]

       The header file <form.h> automatically includes the header
       files <curses.h> and <eti.h>.

       In   your   library   list,  libform.a  should  be  before
       libcurses.a; that is, you want to say  `-lform  -lcurses',
       not  the  other  way  around  (which would give you a link
       error using GNU ld(1) and many other linkers).

PORTABILITY    [Toc]    [Back]

       These routines emulate the System V forms  library.   They
       were not supported on Version 7 or BSD versions.

AUTHORS    [Toc]    [Back]

       Juergen  Pfeifer.  Manual pages and adaptation for ncurses
       by Eric S. Raymond.
[ Back ]
 Similar pages
Name OS Title
menu OpenBSD curses extension for programming menus
menu FreeBSD curses extension for programming menus
top_panel OpenBSD panel stack extension for curses
replace_panel OpenBSD panel stack extension for curses
bottom_panel FreeBSD panel stack extension for curses
update_panels OpenBSD panel stack extension for curses
top_panel FreeBSD panel stack extension for curses
move_panel OpenBSD panel stack extension for curses
show_panel OpenBSD panel stack extension for curses
new_panel OpenBSD panel stack extension for curses
Copyright © 2004-2005 DeniX Solutions SRL
newsletter delivery service