22ca3a1e1176090a5831081d687bb276c68f3f42
[ncurses.git] / form / frm_opts.c
1 /****************************************************************************
2  * Copyright (c) 1998,2000 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  *   Contact: http://www.familiepfeifer.de/Contact.aspx?Lang=en             *
32  ****************************************************************************/
33
34 #include "form.priv.h"
35
36 MODULE_ID("$Id: frm_opts.c,v 1.10 2002/07/06 15:33:27 juergen Exp $")
37
38 /*---------------------------------------------------------------------------
39 |   Facility      :  libnform  
40 |   Function      :  int set_form_opts(FORM *form, Form_Options opts)
41 |   
42 |   Description   :  Turns on the named options and turns off all the
43 |                    remaining options for that form.
44 |
45 |   Return Values :  E_OK              - success
46 |                    E_BAD_ARGUMENT    - invalid options
47 +--------------------------------------------------------------------------*/
48 NCURSES_EXPORT(int)
49 set_form_opts (FORM * form, Form_Options  opts)
50 {
51   opts &= ALL_FORM_OPTS;
52   if (opts & ~ALL_FORM_OPTS)
53     RETURN(E_BAD_ARGUMENT);
54   else
55     {
56       Normalize_Form( form )->opts = opts;
57       RETURN(E_OK);
58     }
59 }
60
61 /*---------------------------------------------------------------------------
62 |   Facility      :  libnform  
63 |   Function      :  Form_Options form_opts(const FORM *)
64 |   
65 |   Description   :  Retrieves the current form options.
66 |
67 |   Return Values :  The option flags.
68 +--------------------------------------------------------------------------*/
69 NCURSES_EXPORT(Form_Options)
70 form_opts (const FORM * form)
71 {
72   return (Normalize_Form(form)->opts & ALL_FORM_OPTS);
73 }
74
75 /*---------------------------------------------------------------------------
76 |   Facility      :  libnform  
77 |   Function      :  int form_opts_on(FORM *form, Form_Options opts)
78 |   
79 |   Description   :  Turns on the named options; no other options are 
80 |                    changed.
81 |
82 |   Return Values :  E_OK            - success 
83 |                    E_BAD_ARGUMENT  - invalid options
84 +--------------------------------------------------------------------------*/
85 NCURSES_EXPORT(int)
86 form_opts_on (FORM * form, Form_Options opts)
87 {
88   opts &= ALL_FORM_OPTS;
89   if (opts & ~ALL_FORM_OPTS)
90     RETURN(E_BAD_ARGUMENT);
91   else
92     {
93       Normalize_Form( form )->opts |= opts;     
94       RETURN(E_OK);
95     }
96 }
97
98 /*---------------------------------------------------------------------------
99 |   Facility      :  libnform  
100 |   Function      :  int form_opts_off(FORM *form, Form_Options opts)
101 |   
102 |   Description   :  Turns off the named options; no other options are 
103 |                    changed.
104 |
105 |   Return Values :  E_OK            - success 
106 |                    E_BAD_ARGUMENT  - invalid options
107 +--------------------------------------------------------------------------*/
108 NCURSES_EXPORT(int)
109 form_opts_off (FORM * form, Form_Options opts)
110 {
111   opts &= ALL_FORM_OPTS;
112   if (opts & ~ALL_FORM_OPTS)
113     RETURN(E_BAD_ARGUMENT);
114   else
115     {
116       Normalize_Form(form)->opts &= ~opts;
117       RETURN(E_OK);
118     }
119 }
120
121 /* frm_opts.c ends here */