Updated formatting of documentation plus a little reorganization.
[cmake.git] / Source / CursesDialog / form / frm_post.c
blobde059191638a8cf93a2f5c83fe7c4656380c18ae
1 /****************************************************************************
2 * Copyright (c) 1998 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 <juergen.pfeifer@gmx.net> 1995,1997 *
31 ****************************************************************************/
32 #include "form.priv.h"
34 MODULE_ID("$Id: frm_post.c,v 1.1 2001-11-05 16:53:03 berk Exp $")
36 /*---------------------------------------------------------------------------
37 | Facility : libnform
38 | Function : int post_form(FORM * form)
40 | Description : Writes the form into its associated subwindow.
42 | Return Values : E_OK - success
43 | E_BAD_ARGUMENT - invalid form pointer
44 | E_POSTED - form already posted
45 | E_NOT_CONNECTED - no fields connected to form
46 | E_NO_ROOM - form doesn't fit into subwindow
47 | E_SYSTEM_ERROR - system error
48 +--------------------------------------------------------------------------*/
49 int post_form(FORM * form)
51 WINDOW *formwin;
52 int err;
53 int page;
55 if (!form)
56 RETURN(E_BAD_ARGUMENT);
58 if (form->status & _POSTED)
59 RETURN(E_POSTED);
61 if (!(form->field))
62 RETURN(E_NOT_CONNECTED);
64 formwin = Get_Form_Window(form);
65 if ((form->cols > getmaxx(formwin)) || (form->rows > getmaxy(formwin)))
66 RETURN(E_NO_ROOM);
68 /* reset form->curpage to an invald value. This forces Set_Form_Page
69 to do the page initialization which is required by post_form.
71 page = form->curpage;
72 form->curpage = -1;
73 if ((err = _nc_Set_Form_Page(form,page,form->current))!=E_OK)
74 RETURN(err);
76 form->status |= _POSTED;
78 Call_Hook(form,forminit);
79 Call_Hook(form,fieldinit);
81 _nc_Refresh_Current_Field(form);
82 RETURN(E_OK);
85 /*---------------------------------------------------------------------------
86 | Facility : libnform
87 | Function : int unpost_form(FORM * form)
89 | Description : Erase form from its associated subwindow.
91 | Return Values : E_OK - success
92 | E_BAD_ARGUMENT - invalid form pointer
93 | E_NOT_POSTED - form isn't posted
94 | E_BAD_STATE - called from a hook routine
95 +--------------------------------------------------------------------------*/
96 int unpost_form(FORM * form)
98 if (!form)
99 RETURN(E_BAD_ARGUMENT);
101 if (!(form->status & _POSTED))
102 RETURN(E_NOT_POSTED);
104 if (form->status & _IN_DRIVER)
105 RETURN(E_BAD_STATE);
107 Call_Hook(form,fieldterm);
108 Call_Hook(form,formterm);
110 werase(Get_Form_Window(form));
111 delwin(form->w);
112 form->w = (WINDOW *)0;
113 form->status &= ~_POSTED;
114 RETURN(E_OK);
117 /* frm_post.c ends here */