ncurses 5.0
[ncurses.git] / form / fld_opts.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_opts.c,v 1.6 1999/05/16 17:19:06 juergen Exp $")
35
36 /*----------------------------------------------------------------------------
37   Field-Options manipulation routines
38   --------------------------------------------------------------------------*/
39
40 /*---------------------------------------------------------------------------
41 |   Facility      :  libnform  
42 |   Function      :  int set_field_opts(FIELD *field, Field_Options opts)
43 |   
44 |   Description   :  Turns on the named options for this field and turns
45 |                    off all the remaining options.
46 |
47 |   Return Values :  E_OK            - success
48 |                    E_CURRENT       - the field is the current field
49 |                    E_BAD_ARGUMENT  - invalid options
50 |                    E_SYSTEM_ERROR  - system error
51 +--------------------------------------------------------------------------*/
52 int set_field_opts(FIELD * field, Field_Options opts)
53 {
54   int res = E_BAD_ARGUMENT;
55   opts &= ALL_FIELD_OPTS;
56   if (!(opts & ~ALL_FIELD_OPTS))
57     res = _nc_Synchronize_Options( Normalize_Field(field), opts );
58   RETURN(res);
59 }
60
61 /*---------------------------------------------------------------------------
62 |   Facility      :  libnform  
63 |   Function      :  Field_Options field_opts(const FIELD *field)
64 |   
65 |   Description   :  Retrieve the fields options.
66 |
67 |   Return Values :  The options.
68 +--------------------------------------------------------------------------*/
69 Field_Options field_opts(const FIELD * field)
70 {
71   return ALL_FIELD_OPTS & Normalize_Field( field )->opts;
72 }
73
74 /*---------------------------------------------------------------------------
75 |   Facility      :  libnform  
76 |   Function      :  int field_opts_on(FIELD *field, Field_Options opts)
77 |   
78 |   Description   :  Turns on the named options for this field and all the 
79 |                    remaining options are unchanged.
80 |
81 |   Return Values :  E_OK            - success
82 |                    E_CURRENT       - the field is the current field
83 |                    E_BAD_ARGUMENT  - invalid options
84 |                    E_SYSTEM_ERROR  - system error
85 +--------------------------------------------------------------------------*/
86 int field_opts_on(FIELD * field, Field_Options opts)
87 {
88   int res = E_BAD_ARGUMENT;
89
90   opts &= ALL_FIELD_OPTS;
91   if (!(opts & ~ALL_FIELD_OPTS))
92     {
93       Normalize_Field( field );
94       res = _nc_Synchronize_Options( field, field->opts | opts );
95     }
96   RETURN(res);
97 }
98
99 /*---------------------------------------------------------------------------
100 |   Facility      :  libnform  
101 |   Function      :  int field_opts_off(FIELD *field, Field_Options opts)
102 |   
103 |   Description   :  Turns off the named options for this field and all the 
104 |                    remaining options are unchanged.
105 |
106 |   Return Values :  E_OK            - success
107 |                    E_CURRENT       - the field is the current field
108 |                    E_BAD_ARGUMENT  - invalid options
109 |                    E_SYSTEM_ERROR  - system error
110 +--------------------------------------------------------------------------*/
111 int field_opts_off(FIELD  * field, Field_Options opts)
112 {
113   int res = E_BAD_ARGUMENT;
114
115   opts &= ALL_FIELD_OPTS;
116   if (!(opts & ~ALL_FIELD_OPTS))
117     {
118       Normalize_Field( field );
119       res = _nc_Synchronize_Options( field, field->opts & ~opts );
120     }
121   RETURN(res);
122 }       
123
124 /* fld_opts.c ends here */