xref: /freebsd/contrib/ncurses/man/form_new_page.3x (revision 3b68c491d37196bb76a95bce3c02f7c6d5ba22fd)
***************************************************************************
Copyright 2018-2023,2024 Thomas E. Dickey *
Copyright 1998-2010,2015 Free Software Foundation, Inc. *
*
Permission is hereby granted, free of charge, to any person obtaining a *
copy of this software and associated documentation files (the *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: form_new_page.3x,v 1.34 2024/03/16 15:35:01 tom Exp $
form_new_page 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls"
.\} .\}
NAME
set_new_page, new_page - form pagination functions
SYNOPSIS
#include <form.h>

int set_new_page(FIELD *field, bool new_page_flag); bool new_page(const FIELD *field);

DESCRIPTION
The function set_new_page sets or resets a flag marking the given field as the beginning of a new page on its form.

The function new_page is a predicate which tests if a given field marks a page beginning on its form.

RETURN VALUE
The function new_page returns TRUE or FALSE.

The function set_new_page returns one of the following:

5 E_OK The routine succeeded.

5 E_CONNECTED The given field is already connected to a form.

PORTABILITY
These routines emulate the System V forms library. They were not supported on Version 7 or BSD versions.
AUTHORS
Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.
SEE ALSO
\%curses(3X) and related pages whose names begin \*(``form_\*('' for detailed descriptions of the entry points.