doc/html/man/form_win.3x.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   * t
   4   ****************************************************************************
   5   * Copyright (c) 1998 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_win.3x,v 1.8 1999/04/10 23:36:08 tom Exp @
  32 -->
  33 <HTML>
  34 <HEAD>
  35 <TITLE>form_win 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_win 3x</H1>
  41 <HR>
  42 <PRE>
  43 <!-- Manpage converted by man2html 3.0.1 -->
  44 <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>                                               <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2>NAME</H2><PRE>
  51        <STRONG>form_win</STRONG>  - make and break form window and subwindow asso-
  52        ciations
  53
  54
  55 </PRE>
  56 <H2>SYNOPSIS</H2><PRE>
  57        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
  58        int set_form_win(FORM *form, WINDOW *win);
  59        WINDOW *form_win(const FORM *form);
  60        int set_form_sub(FORM *form, WINDOW *sub);
  61        WINDOW *form_sub(const FORM *form);
  62        int scale_form(const FORM *form, int *rows, int *columns);
  63
  64
  65 </PRE>
  66 <H2>DESCRIPTION</H2><PRE>
  67        Every  form has an associated pair of <STRONG>curses</STRONG> windows.  The
  68        form window displays any title and border associated  with
  69        the  window;  the form subwindow displays the items of the
  70        form that are currently available for selection.
  71
  72        The first four functions get and set those windows.  It is
  73        not necessary to set either window; by default, the driver
  74        code uses <STRONG>stdscr</STRONG> for both.
  75
  76        In the <STRONG>set_</STRONG> functions, window argument of <STRONG>NULL</STRONG> is  treated
  77        as  though  it  were  <STRONG>stsdcr</STRONG>.   A form argument of <STRONG>NULL</STRONG> is
  78        treated as a request to change  the  system  default  form
  79        window or subwindow.
  80
  81        The  function <STRONG>scale_form</STRONG> returns the minimum size required
  82        for the subwindow of <EM>form</EM>.
  83
  84
  85 </PRE>
  86 <H2>RETURN VALUE</H2><PRE>
  87        Routines that return pointers return <STRONG>NULL</STRONG> on error.   Rou-
  88        tines  that  return an integer return one of the following
  89        error codes:
  90
  91        <STRONG>E_OK</STRONG> The routine succeeded.
  92
  93        <STRONG>E_SYSTEM_ERROR</STRONG>
  94             System error occurred (see <STRONG>errno</STRONG>).
  95
  96        <STRONG>E_BAD_ARGUMENT</STRONG>
  97             Routine detected an incorrect or  out-of-range  argu-
  98             ment.
  99
 100        <STRONG>E_POSTED</STRONG>
 101             The form has already been posted.
 102
 103        <STRONG>E_NOT_CONNECTED</STRONG>
 104             No items are connected to the form.
 105
 106
 107 </PRE>
 108 <H2>SEE ALSO</H2><PRE>
 109        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
 110
 111
 112 </PRE>
 113 <H2>NOTES</H2><PRE>
 114        The header file <STRONG>&lt;form.h&gt;</STRONG> automatically includes the header
 115        file <STRONG>&lt;curses.h&gt;</STRONG>.
 116
 117
 118 </PRE>
 119 <H2>PORTABILITY</H2><PRE>
 120        These routines emulate the System V forms  library.   They
 121        were not supported on Version 7 or BSD versions.
 122
 123
 124 </PRE>
 125 <H2>AUTHORS</H2><PRE>
 126        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
 127        curses by Eric S. Raymond.
 128
 129
 130
 131                                                            <STRONG><A HREF="form_win.3x.html">form_win(3x)</A></STRONG>
 132 </PRE>
 133 <HR>
 134 <ADDRESS>
 135 Man(1) output converted with
 136 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 137 </ADDRESS>
 138 </BODY>
 139 </HTML>