324198c42bae845e045e65d9b1cae5665a2a4c6a
[ncurses.git] / form / fld_info.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: fld_info.c,v 1.10 2004/12/11 22:24:57 tom Exp $")
36
37 /*---------------------------------------------------------------------------
38 |   Facility      :  libnform  
39 |   Function      :  int field_info(const FIELD *field,
40 |                                   int *rows, int *cols,
41 |                                   int *frow, int *fcol,
42 |                                   int *nrow, int *nbuf)
43 |   
44 |   Description   :  Retrieve infos about the fields creation parameters.
45 |
46 |   Return Values :  E_OK           - success
47 |                    E_BAD_ARGUMENT - invalid field pointer
48 +--------------------------------------------------------------------------*/
49 NCURSES_EXPORT(int)
50 field_info(const FIELD *field,
51            int *rows, int *cols,
52            int *frow, int *fcol,
53            int *nrow, int *nbuf)
54 {
55   T((T_CALLED("field_info(%p,%p,%p,%p,%p,%p,%p)"),
56      field,
57      rows, cols,
58      frow, fcol,
59      nrow, nbuf));
60
61   if (!field)
62     RETURN(E_BAD_ARGUMENT);
63
64   if (rows)
65     *rows = field->rows;
66   if (cols)
67     *cols = field->cols;
68   if (frow)
69     *frow = field->frow;
70   if (fcol)
71     *fcol = field->fcol;
72   if (nrow)
73     *nrow = field->nrow;
74   if (nbuf)
75     *nbuf = field->nbuf;
76   RETURN(E_OK);
77 }
78
79 /*---------------------------------------------------------------------------
80 |   Facility      :  libnform  
81 |   Function      :  int dynamic_field_info(const FIELD *field,
82 |                                           int *drows, int *dcols,
83 |                                           int *maxgrow)
84 |   
85 |   Description   :  Retrieve informations about a dynamic fields current
86 |                    dynamic parameters.
87 |
88 |   Return Values :  E_OK           - success
89 |                    E_BAD_ARGUMENT - invalid argument
90 +--------------------------------------------------------------------------*/
91 NCURSES_EXPORT(int)
92 dynamic_field_info(const FIELD *field, int *drows, int *dcols, int *maxgrow)
93 {
94   T((T_CALLED("dynamic_field_info(%p,%p,%p,%p)"), field, drows, dcols, maxgrow));
95
96   if (!field)
97     RETURN(E_BAD_ARGUMENT);
98
99   if (drows)
100     *drows = field->drows;
101   if (dcols)
102     *dcols = field->dcols;
103   if (maxgrow)
104     *maxgrow = field->maxgrow;
105
106   RETURN(E_OK);
107 }
108
109 /* fld_info.c ends here */