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