ncurses 5.4
[ncurses.git] / form / fld_attr.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_attr.c,v 1.7 2003/10/25 15:17: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    if ( attr==A_NORMAL || ((attr & A_ATTRIBUTES)==attr) )\
46      {\
47        Normalize_Field( field );\
48        if ((field -> name) != attr)\
49          {\
50            field -> name = attr;\
51            res = _nc_Synchronize_Attributes( field );\
52          }\
53        else\
54          res = E_OK;\
55      }\
56    RETURN(res);\
57 }
58
59 /* "Template" macro to generate a function to get a fields attribute */
60 #define GEN_FIELD_ATTR_GET_FCT( name ) \
61 NCURSES_IMPEXP chtype NCURSES_API field_ ## name (const FIELD * field)\
62 {\
63    return ( A_ATTRIBUTES & (Normalize_Field( field ) -> name) );\
64 }
65
66 /*---------------------------------------------------------------------------
67 |   Facility      :  libnform  
68 |   Function      :  int set_field_fore(FIELD *field, chtype attr)
69 |   
70 |   Description   :  Sets the foreground of the field used to display the
71 |                    field contents.
72 |
73 |   Return Values :  E_OK             - success
74 |                    E_BAD_ARGUMENT   - invalid attributes
75 |                    E_SYSTEM_ERROR   - system error
76 +--------------------------------------------------------------------------*/
77 GEN_FIELD_ATTR_SET_FCT( fore )
78
79 /*---------------------------------------------------------------------------
80 |   Facility      :  libnform  
81 |   Function      :  chtype field_fore(const FIELD *)
82 |   
83 |   Description   :  Retrieve fields foreground attribute
84 |
85 |   Return Values :  The foreground attribute
86 +--------------------------------------------------------------------------*/
87 GEN_FIELD_ATTR_GET_FCT( fore )
88
89 /*---------------------------------------------------------------------------
90 |   Facility      :  libnform  
91 |   Function      :  int set_field_back(FIELD *field, chtype attr)
92 |   
93 |   Description   :  Sets the background of the field used to display the
94 |                    fields extend.
95 |
96 |   Return Values :  E_OK             - success
97 |                    E_BAD_ARGUMENT   - invalid attributes
98 |                    E_SYSTEM_ERROR   - system error
99 +--------------------------------------------------------------------------*/
100 GEN_FIELD_ATTR_SET_FCT( back )
101
102 /*---------------------------------------------------------------------------
103 |   Facility      :  libnform
104 |   Function      :  chtype field_back(const 
105 |   
106 |   Description   :  Retrieve fields background attribute
107 |
108 |   Return Values :  The background attribute
109 +--------------------------------------------------------------------------*/
110 GEN_FIELD_ATTR_GET_FCT( back )
111
112 /* fld_attr.c ends here */