ncurses 5.7 - patch 20100123
[ncurses.git] / form / frm_opts.c
1 /****************************************************************************
2  * Copyright (c) 1998-2005,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: frm_opts.c,v 1.15 2010/01/23 21:14:36 tom Exp $")
36
37 /*---------------------------------------------------------------------------
38 |   Facility      :  libnform  
39 |   Function      :  int set_form_opts(FORM *form, Form_Options opts)
40 |   
41 |   Description   :  Turns on the named options and turns off all the
42 |                    remaining options for that form.
43 |
44 |   Return Values :  E_OK              - success
45 |                    E_BAD_ARGUMENT    - invalid options
46 +--------------------------------------------------------------------------*/
47 NCURSES_EXPORT(int)
48 set_form_opts(FORM *form, Form_Options opts)
49 {
50   T((T_CALLED("set_form_opts(%p,%d)"), (void *)form, opts));
51
52   opts &= ALL_FORM_OPTS;
53   if (opts & ~ALL_FORM_OPTS)
54     RETURN(E_BAD_ARGUMENT);
55   else
56     {
57       Normalize_Form(form)->opts = opts;
58       RETURN(E_OK);
59     }
60 }
61
62 /*---------------------------------------------------------------------------
63 |   Facility      :  libnform  
64 |   Function      :  Form_Options form_opts(const FORM *)
65 |   
66 |   Description   :  Retrieves the current form options.
67 |
68 |   Return Values :  The option flags.
69 +--------------------------------------------------------------------------*/
70 NCURSES_EXPORT(Form_Options)
71 form_opts(const FORM *form)
72 {
73   T((T_CALLED("form_opts(%p)"), (const void *)form));
74   returnCode((int)(Normalize_Form(form)->opts & ALL_FORM_OPTS));
75 }
76
77 /*---------------------------------------------------------------------------
78 |   Facility      :  libnform  
79 |   Function      :  int form_opts_on(FORM *form, Form_Options opts)
80 |   
81 |   Description   :  Turns on the named options; no other options are 
82 |                    changed.
83 |
84 |   Return Values :  E_OK            - success 
85 |                    E_BAD_ARGUMENT  - invalid options
86 +--------------------------------------------------------------------------*/
87 NCURSES_EXPORT(int)
88 form_opts_on(FORM *form, Form_Options opts)
89 {
90   T((T_CALLED("form_opts_on(%p,%d)"), (void *)form, opts));
91
92   opts &= ALL_FORM_OPTS;
93   if (opts & ~ALL_FORM_OPTS)
94     RETURN(E_BAD_ARGUMENT);
95   else
96     {
97       Normalize_Form(form)->opts |= opts;
98       RETURN(E_OK);
99     }
100 }
101
102 /*---------------------------------------------------------------------------
103 |   Facility      :  libnform  
104 |   Function      :  int form_opts_off(FORM *form, Form_Options opts)
105 |   
106 |   Description   :  Turns off the named options; no other options are 
107 |                    changed.
108 |
109 |   Return Values :  E_OK            - success 
110 |                    E_BAD_ARGUMENT  - invalid options
111 +--------------------------------------------------------------------------*/
112 NCURSES_EXPORT(int)
113 form_opts_off(FORM *form, Form_Options opts)
114 {
115   T((T_CALLED("form_opts_off(%p,%d)"), (void *)form, opts));
116
117   opts &= ALL_FORM_OPTS;
118   if (opts & ~ALL_FORM_OPTS)
119     RETURN(E_BAD_ARGUMENT);
120   else
121     {
122       Normalize_Form(form)->opts &= ~opts;
123       RETURN(E_OK);
124     }
125 }
126
127 /* frm_opts.c ends here */