contrib/ncurses-5.4/form/fld_info.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2002,2003 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.7 2003/10/25 15:17:08 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
  51     (const FIELD *field,
  52      int *rows, int *cols,
  53      int *frow, int *fcol,
  54      int *nrow, int *nbuf)
  55 {
  56   if (!field)
  57     RETURN(E_BAD_ARGUMENT);
  58
  59   if (rows) *rows = field->rows;
  60   if (cols) *cols = field->cols;
  61   if (frow) *frow = field->frow;
  62   if (fcol) *fcol = field->fcol;
  63   if (nrow) *nrow = field->nrow;
  64   if (nbuf) *nbuf = field->nbuf;
  65   RETURN(E_OK);
  66 }
  67
  68 /*---------------------------------------------------------------------------
  69 |   Facility      :  libnform
  70 |   Function      :  int dynamic_field_info(const FIELD *field,
  71 |                                           int *drows, int *dcols,
  72 |                                           int *maxgrow)
  73 |
  74 |   Description   :  Retrieve informations about a dynamic fields current
  75 |                    dynamic parameters.
  76 |
  77 |   Return Values :  E_OK           - success
  78 |                    E_BAD_ARGUMENT - invalid argument
  79 +--------------------------------------------------------------------------*/
  80 NCURSES_EXPORT(int)
  81 dynamic_field_info
  82 (const FIELD *field, int *drows, int *dcols, int *maxgrow)
  83 {
  84   if (!field)
  85     RETURN(E_BAD_ARGUMENT);
  86
  87   if (drows)   *drows   = field->drows;
  88   if (dcols)   *dcols   = field->dcols;
  89   if (maxgrow) *maxgrow = field->maxgrow;
  90
  91   RETURN(E_OK);
  92 }
  93
  94 /* fld_info.c ends here */