form/fld_page.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2010,2012 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  ****************************************************************************/
  28
  29 /****************************************************************************
  30  *   Author:  Juergen Pfeifer, 1995,1997                                    *
  31  ****************************************************************************/
  32
  33 #include "form.priv.h"
  34
  35 MODULE_ID("$Id: fld_page.c,v 1.12 2012/06/10 00:12:47 tom Exp $")
  36
  37 /*---------------------------------------------------------------------------
  38 |   Facility      :  libnform
  39 |   Function      :  int set_new_page(FIELD *field, bool new_page_flag)
  40 |
  41 |   Description   :  Marks the field as the beginning of a new page of
  42 |                    the form.
  43 |
  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)
  49 {
  50   T((T_CALLED("set_new_page(%p,%d)"), (void *)field, new_page_flag));
  51
  52   Normalize_Field(field);
  53   if (field->form)
  54     RETURN(E_CONNECTED);
  55
  56   if (new_page_flag)
  57     SetStatus(field, _NEWPAGE);
  58   else
  59     ClrStatus(field, _NEWPAGE);
  60
  61   RETURN(E_OK);
  62 }
  63
  64 /*---------------------------------------------------------------------------
  65 |   Facility      :  libnform
  66 |   Function      :  bool new_page(const FIELD *field)
  67 |
  68 |   Description   :  Retrieve the info whether or not the field starts a
  69 |                    new page on the form.
  70 |
  71 |   Return Values :  TRUE  - field starts a new page
  72 |                    FALSE - field doesn't start a new page
  73 +--------------------------------------------------------------------------*/
  74 NCURSES_EXPORT(bool)
  75 new_page(const FIELD *field)
  76 {
  77   T((T_CALLED("new_page(%p)"), (const void *)field));
  78
  79   returnBool((Normalize_Field(field)->status & _NEWPAGE) ? TRUE : FALSE);
  80 }
  81
  82 /* fld_page.c ends here */