a371838d950ed882d83650db901df93178c806c0
[ncurses.git] / form / frm_page.c
1 /****************************************************************************
2  * Copyright (c) 1998-2003,2004 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: frm_page.c,v 1.10 2004/12/11 22:08:21 tom Exp $")
36
37 /*---------------------------------------------------------------------------
38 |   Facility      :  libnform  
39 |   Function      :  int set_form_page(FORM * form,int  page)
40 |   
41 |   Description   :  Set the page number of the form.
42 |
43 |   Return Values :  E_OK              - success
44 |                    E_BAD_ARGUMENT    - invalid form pointer or page number
45 |                    E_BAD_STATE       - called from a hook routine
46 |                    E_INVALID_FIELD   - current field can't be left
47 |                    E_SYSTEM_ERROR    - system error
48 +--------------------------------------------------------------------------*/
49 NCURSES_EXPORT(int)
50 set_form_page(FORM *form, int page)
51 {
52   int err = E_OK;
53
54   T((T_CALLED("set_form_page(%p,%d)"), form, page));
55
56   if (!form || (page < 0) || (page >= form->maxpage))
57     RETURN(E_BAD_ARGUMENT);
58
59   if (!(form->status & _POSTED))
60     {
61       form->curpage = page;
62       form->current = _nc_First_Active_Field(form);
63     }
64   else
65     {
66       if (form->status & _IN_DRIVER)
67         err = E_BAD_STATE;
68       else
69         {
70           if (form->curpage != page)
71             {
72               if (!_nc_Internal_Validation(form))
73                 err = E_INVALID_FIELD;
74               else
75                 {
76                   Call_Hook(form, fieldterm);
77                   Call_Hook(form, formterm);
78                   err = _nc_Set_Form_Page(form, page, (FIELD *)0);
79                   Call_Hook(form, forminit);
80                   Call_Hook(form, fieldinit);
81                   _nc_Refresh_Current_Field(form);
82                 }
83             }
84         }
85     }
86   RETURN(err);
87 }
88
89 /*---------------------------------------------------------------------------
90 |   Facility      :  libnform  
91 |   Function      :  int form_page(const FORM * form)
92 |   
93 |   Description   :  Return the current page of the form.
94 |
95 |   Return Values :  >= 0  : current page number
96 |                    -1    : invalid form pointer
97 +--------------------------------------------------------------------------*/
98 NCURSES_EXPORT(int)
99 form_page(const FORM *form)
100 {
101   T((T_CALLED("form_page(%p)"), form));
102
103   returnCode(Normalize_Form(form)->curpage);
104 }
105
106 /* frm_page.c ends here */