ncurses 5.0
[ncurses.git] / form / frm_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
33 #include "form.priv.h"
34
35 MODULE_ID("$Id: frm_opts.c,v 1.8 1999/05/16 17:38:05 juergen 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 int set_form_opts(FORM * form, Form_Options  opts)
48 {
49   opts &= ALL_FORM_OPTS;
50   if (opts & ~ALL_FORM_OPTS)
51     RETURN(E_BAD_ARGUMENT);
52   else
53     {
54       Normalize_Form( form )->opts = opts;
55       RETURN(E_OK);
56     }
57 }
58
59 /*---------------------------------------------------------------------------
60 |   Facility      :  libnform  
61 |   Function      :  Form_Options form_opts(const FORM *)
62 |   
63 |   Description   :  Retrieves the current form options.
64 |
65 |   Return Values :  The option flags.
66 +--------------------------------------------------------------------------*/
67 Form_Options form_opts(const FORM * form)
68 {
69   return (Normalize_Form(form)->opts & ALL_FORM_OPTS);
70 }
71
72 /*---------------------------------------------------------------------------
73 |   Facility      :  libnform  
74 |   Function      :  int form_opts_on(FORM *form, Form_Options opts)
75 |   
76 |   Description   :  Turns on the named options; no other options are 
77 |                    changed.
78 |
79 |   Return Values :  E_OK            - success 
80 |                    E_BAD_ARGUMENT  - invalid options
81 +--------------------------------------------------------------------------*/
82 int form_opts_on(FORM * form, Form_Options opts)
83 {
84   opts &= ALL_FORM_OPTS;
85   if (opts & ~ALL_FORM_OPTS)
86     RETURN(E_BAD_ARGUMENT);
87   else
88     {
89       Normalize_Form( form )->opts |= opts;     
90       RETURN(E_OK);
91     }
92 }
93
94 /*---------------------------------------------------------------------------
95 |   Facility      :  libnform  
96 |   Function      :  int form_opts_off(FORM *form, Form_Options opts)
97 |   
98 |   Description   :  Turns off the named options; no other options are 
99 |                    changed.
100 |
101 |   Return Values :  E_OK            - success 
102 |                    E_BAD_ARGUMENT  - invalid options
103 +--------------------------------------------------------------------------*/
104 int form_opts_off(FORM * form, Form_Options opts)
105 {
106   opts &= ALL_FORM_OPTS;
107   if (opts & ~ALL_FORM_OPTS)
108     RETURN(E_BAD_ARGUMENT);
109   else
110     {
111       Normalize_Form(form)->opts &= ~opts;
112       RETURN(E_OK);
113     }
114 }
115
116 /* frm_opts.c ends here */