0b8032d12511a19944244385fd62b6aca7d6efa2
[ncurses.git] / form / frm_opts.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: frm_opts.c,v 1.11 2003/10/25 15:17:08 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   opts &= ALL_FORM_OPTS;
51   if (opts & ~ALL_FORM_OPTS)
52     RETURN(E_BAD_ARGUMENT);
53   else
54     {
55       Normalize_Form( form )->opts = opts;
56       RETURN(E_OK);
57     }
58 }
59
60 /*---------------------------------------------------------------------------
61 |   Facility      :  libnform  
62 |   Function      :  Form_Options form_opts(const FORM *)
63 |   
64 |   Description   :  Retrieves the current form options.
65 |
66 |   Return Values :  The option flags.
67 +--------------------------------------------------------------------------*/
68 NCURSES_EXPORT(Form_Options)
69 form_opts (const FORM * form)
70 {
71   return (Normalize_Form(form)->opts & ALL_FORM_OPTS);
72 }
73
74 /*---------------------------------------------------------------------------
75 |   Facility      :  libnform  
76 |   Function      :  int form_opts_on(FORM *form, Form_Options opts)
77 |   
78 |   Description   :  Turns on the named options; no other options are 
79 |                    changed.
80 |
81 |   Return Values :  E_OK            - success 
82 |                    E_BAD_ARGUMENT  - invalid options
83 +--------------------------------------------------------------------------*/
84 NCURSES_EXPORT(int)
85 form_opts_on (FORM * form, Form_Options opts)
86 {
87   opts &= ALL_FORM_OPTS;
88   if (opts & ~ALL_FORM_OPTS)
89     RETURN(E_BAD_ARGUMENT);
90   else
91     {
92       Normalize_Form( form )->opts |= opts;     
93       RETURN(E_OK);
94     }
95 }
96
97 /*---------------------------------------------------------------------------
98 |   Facility      :  libnform  
99 |   Function      :  int form_opts_off(FORM *form, Form_Options opts)
100 |   
101 |   Description   :  Turns off the named options; no other options are 
102 |                    changed.
103 |
104 |   Return Values :  E_OK            - success 
105 |                    E_BAD_ARGUMENT  - invalid options
106 +--------------------------------------------------------------------------*/
107 NCURSES_EXPORT(int)
108 form_opts_off (FORM * form, Form_Options opts)
109 {
110   opts &= ALL_FORM_OPTS;
111   if (opts & ~ALL_FORM_OPTS)
112     RETURN(E_BAD_ARGUMENT);
113   else
114     {
115       Normalize_Form(form)->opts &= ~opts;
116       RETURN(E_OK);
117     }
118 }
119
120 /* frm_opts.c ends here */