ncurses 6.2 - patch 20210403
[ncurses.git] / doc / html / man / form_data.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018,2020 Thomas E. Dickey                                     *
5   * Copyright 1998-2010,2015 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_data.3x,v 1.15 2020/10/18 00:15:00 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>form_data 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">form_data 3x</H1>
44 <PRE>
45 <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG>                                                    <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>data_ahead</STRONG>, <STRONG>data_behind</STRONG> - test for off-screen data in given forms
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;form.h&gt;</STRONG>
56
57        <STRONG>bool</STRONG> <STRONG>data_ahead(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
58        <STRONG>bool</STRONG> <STRONG>data_behind(const</STRONG> <STRONG>FORM</STRONG> <STRONG>*</STRONG><EM>form</EM><STRONG>);</STRONG>
59
60
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62        The function <STRONG>data_ahead</STRONG> tests whether there is off-screen data ahead in
63        the given form.  It returns TRUE (1) or FALSE (0).
64
65        The function <STRONG>data_behind</STRONG> tests whether there is off-screen data  behind
66        in the given form.  It returns TRUE (1) or FALSE (0).
67
68
69 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
70        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="form.3x.html">form(3x)</A></STRONG>.
71
72
73 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
74        The  header  file  <STRONG>&lt;form.h&gt;</STRONG>  automatically  includes  the  header  file
75        <STRONG>&lt;curses.h&gt;</STRONG>.
76
77
78 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
79        These routines emulate the System  V  forms  library.   They  were  not
80        supported on Version 7 or BSD versions.
81
82
83 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
84        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
85        Raymond.
86
87
88
89                                                                  <STRONG><A HREF="form_data.3x.html">form_data(3x)</A></STRONG>
90 </PRE>
91 <div class="nav">
92 <ul>
93 <li><a href="#h2-NAME">NAME</a></li>
94 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
95 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
96 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
97 <li><a href="#h2-NOTES">NOTES</a></li>
98 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
99 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
100 </ul>
101 </div>
102 </BODY>
103 </HTML>