form/fld_attr.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2004,2010 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_attr.c,v 1.11 2010/01/23 21:12:08 tom Exp $")
  36
  37 /*----------------------------------------------------------------------------
  38   Field-Attribute manipulation routines
  39   --------------------------------------------------------------------------*/
  40 /* "Template" macro to generate a function to set a fields attribute */
  41 #define GEN_FIELD_ATTR_SET_FCT( name ) \
  42 NCURSES_IMPEXP int NCURSES_API set_field_ ## name (FIELD * field, chtype attr)\
  43 {\
  44    int res = E_BAD_ARGUMENT;\
  45    T((T_CALLED("set_field_" #name "(%p,%s)"), field, _traceattr(attr)));\
  46    if ( attr==A_NORMAL || ((attr & A_ATTRIBUTES)==attr) )\
  47      {\
  48        Normalize_Field( field );\
  49        if (field != 0) \
  50          { \
  51          if ((field -> name) != attr)\
  52            {\
  53              field -> name = attr;\
  54              res = _nc_Synchronize_Attributes( field );\
  55            }\
  56          else\
  57            {\
  58              res = E_OK;\
  59            }\
  60          }\
  61      }\
  62    RETURN(res);\
  63 }
  64
  65 /* "Template" macro to generate a function to get a fields attribute */
  66 #define GEN_FIELD_ATTR_GET_FCT( name ) \
  67 NCURSES_IMPEXP chtype NCURSES_API field_ ## name (const FIELD * field)\
  68 {\
  69    T((T_CALLED("field_" #name "(%p)"), (const void *) field));\
  70    returnAttr( A_ATTRIBUTES & (Normalize_Field( field ) -> name) );\
  71 }
  72
  73 /*---------------------------------------------------------------------------
  74 |   Facility      :  libnform
  75 |   Function      :  int set_field_fore(FIELD *field, chtype attr)
  76 |
  77 |   Description   :  Sets the foreground of the field used to display the
  78 |                    field contents.
  79 |
  80 |   Return Values :  E_OK             - success
  81 |                    E_BAD_ARGUMENT   - invalid attributes
  82 |                    E_SYSTEM_ERROR   - system error
  83 +--------------------------------------------------------------------------*/
  84 GEN_FIELD_ATTR_SET_FCT(fore)
  85
  86 /*---------------------------------------------------------------------------
  87 |   Facility      :  libnform
  88 |   Function      :  chtype field_fore(const FIELD *)
  89 |
  90 |   Description   :  Retrieve fields foreground attribute
  91 |
  92 |   Return Values :  The foreground attribute
  93 +--------------------------------------------------------------------------*/
  94 GEN_FIELD_ATTR_GET_FCT(fore)
  95
  96 /*---------------------------------------------------------------------------
  97 |   Facility      :  libnform
  98 |   Function      :  int set_field_back(FIELD *field, chtype attr)
  99 |
 100 |   Description   :  Sets the background of the field used to display the
 101 |                    fields extend.
 102 |
 103 |   Return Values :  E_OK             - success
 104 |                    E_BAD_ARGUMENT   - invalid attributes
 105 |                    E_SYSTEM_ERROR   - system error
 106 +--------------------------------------------------------------------------*/
 107 GEN_FIELD_ATTR_SET_FCT(back)
 108
 109 /*---------------------------------------------------------------------------
 110 |   Facility      :  libnform
 111 |   Function      :  chtype field_back(const
 112 |
 113 |   Description   :  Retrieve fields background attribute
 114 |
 115 |   Return Values :  The background attribute
 116 +--------------------------------------------------------------------------*/
 117 GEN_FIELD_ATTR_GET_FCT(back)
 118
 119 /* fld_attr.c ends here */