ncurses 5.0
[ncurses.git] / form / fld_attr.c
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  ****************************************************************************/
28
29 /****************************************************************************
30  *   Author: Juergen Pfeifer <juergen.pfeifer@gmx.net> 1995,1997            *
31  ****************************************************************************/
32 #include "form.priv.h"
33
34 MODULE_ID("$Id: fld_attr.c,v 1.4 1999/05/16 17:16:30 juergen Exp $")
35
36 /*----------------------------------------------------------------------------
37   Field-Attribute manipulation routines
38   --------------------------------------------------------------------------*/
39 /* "Template" macro to generate a function to set a fields attribute */
40 #define GEN_FIELD_ATTR_SET_FCT( name ) \
41 int set_field_ ## name (FIELD * field, chtype attr)\
42 {\
43    int res = E_BAD_ARGUMENT;\
44    if ( attr==A_NORMAL || ((attr & A_ATTRIBUTES)==attr) )\
45      {\
46        Normalize_Field( field );\
47        if ((field -> name) != attr)\
48          {\
49            field -> name = attr;\
50            res = _nc_Synchronize_Attributes( field );\
51          }\
52        else\
53          res = E_OK;\
54      }\
55    RETURN(res);\
56 }
57
58 /* "Template" macro to generate a function to get a fields attribute */
59 #define GEN_FIELD_ATTR_GET_FCT( name ) \
60 chtype field_ ## name (const FIELD * field)\
61 {\
62    return ( A_ATTRIBUTES & (Normalize_Field( field ) -> name) );\
63 }
64
65 /*---------------------------------------------------------------------------
66 |   Facility      :  libnform  
67 |   Function      :  int set_field_fore(FIELD *field, chtype attr)
68 |   
69 |   Description   :  Sets the foreground of the field used to display the
70 |                    field contents.
71 |
72 |   Return Values :  E_OK             - success
73 |                    E_BAD_ARGUMENT   - invalid attributes
74 |                    E_SYSTEM_ERROR   - system error
75 +--------------------------------------------------------------------------*/
76 GEN_FIELD_ATTR_SET_FCT( fore )
77
78 /*---------------------------------------------------------------------------
79 |   Facility      :  libnform  
80 |   Function      :  chtype field_fore(const FIELD *)
81 |   
82 |   Description   :  Retrieve fields foreground attribute
83 |
84 |   Return Values :  The foreground attribute
85 +--------------------------------------------------------------------------*/
86 GEN_FIELD_ATTR_GET_FCT( fore )
87
88 /*---------------------------------------------------------------------------
89 |   Facility      :  libnform  
90 |   Function      :  int set_field_back(FIELD *field, chtype attr)
91 |   
92 |   Description   :  Sets the background of the field used to display the
93 |                    fields extend.
94 |
95 |   Return Values :  E_OK             - success
96 |                    E_BAD_ARGUMENT   - invalid attributes
97 |                    E_SYSTEM_ERROR   - system error
98 +--------------------------------------------------------------------------*/
99 GEN_FIELD_ATTR_SET_FCT( back )
100
101 /*---------------------------------------------------------------------------
102 |   Facility      :  libnform
103 |   Function      :  chtype field_back(const 
104 |   
105 |   Description   :  Retrieve fields background attribute
106 |
107 |   Return Values :  The background attribute
108 +--------------------------------------------------------------------------*/
109 GEN_FIELD_ATTR_GET_FCT( back )
110
111 /* fld_attr.c ends here */