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