18dabab2088907ff7564c896ef7f25f11897a859
[ncurses.git] / form / frm_cursor.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_cursor.c,v 1.9 2004/12/11 22:01:03 tom Exp $")
36
37 /*---------------------------------------------------------------------------
38 |   Facility      :  libnform  
39 |   Function      :  int pos_form_cursor(FORM * form)
40 |   
41 |   Description   :  Moves the form window cursor to the location required
42 |                    by the form driver to resume form processing. This may
43 |                    be needed after the application calls a curses library
44 |                    I/O routine that modifies the cursor position.
45 |
46 |   Return Values :  E_OK                      - Success
47 |                    E_SYSTEM_ERROR            - System error.
48 |                    E_BAD_ARGUMENT            - Invalid form pointer
49 |                    E_NOT_POSTED              - Form is not posted
50 +--------------------------------------------------------------------------*/
51 NCURSES_EXPORT(int)
52 pos_form_cursor(FORM *form)
53 {
54   int res;
55
56   T((T_CALLED("pos_form_cursor(%p)"), form));
57
58   if (!form)
59     res = E_BAD_ARGUMENT;
60   else
61     {
62       if (!(form->status & _POSTED))
63         res = E_NOT_POSTED;
64       else
65         res = _nc_Position_Form_Cursor(form);
66     }
67   RETURN(res);
68 }
69
70 /* frm_cursor.c ends here */