ncurses 6.2 - patch 20200509
[ncurses.git] / form / fld_page.c
1 /****************************************************************************
2  * Copyright 2020 Thomas E. Dickey                                          *
3  * Copyright 1998-2010,2012 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *   Author:  Juergen Pfeifer, 1995,1997                                    *
32  ****************************************************************************/
33
34 #include "form.priv.h"
35
36 MODULE_ID("$Id: fld_page.c,v 1.13 2020/02/02 23:34:34 tom Exp $")
37
38 /*---------------------------------------------------------------------------
39 |   Facility      :  libnform  
40 |   Function      :  int set_new_page(FIELD *field, bool new_page_flag)
41 |   
42 |   Description   :  Marks the field as the beginning of a new page of 
43 |                    the form.
44 |
45 |   Return Values :  E_OK         - success
46 |                    E_CONNECTED  - field is connected
47 +--------------------------------------------------------------------------*/
48 NCURSES_EXPORT(int)
49 set_new_page(FIELD *field, bool new_page_flag)
50 {
51   T((T_CALLED("set_new_page(%p,%d)"), (void *)field, new_page_flag));
52
53   Normalize_Field(field);
54   if (field->form)
55     RETURN(E_CONNECTED);
56
57   if (new_page_flag)
58     SetStatus(field, _NEWPAGE);
59   else
60     ClrStatus(field, _NEWPAGE);
61
62   RETURN(E_OK);
63 }
64
65 /*---------------------------------------------------------------------------
66 |   Facility      :  libnform  
67 |   Function      :  bool new_page(const FIELD *field)
68 |   
69 |   Description   :  Retrieve the info whether or not the field starts a
70 |                    new page on the form.
71 |
72 |   Return Values :  TRUE  - field starts a new page
73 |                    FALSE - field doesn't start a new page
74 +--------------------------------------------------------------------------*/
75 NCURSES_EXPORT(bool)
76 new_page(const FIELD *field)
77 {
78   T((T_CALLED("new_page(%p)"), (const void *)field));
79
80   returnBool((Normalize_Field(field)->status & _NEWPAGE) ? TRUE : FALSE);
81 }
82
83 /* fld_page.c ends here */