cfe7b75db392bb7e2c403f1ce4520ad7bc015afe
[ncurses.git] / menu / m_item_opt.c
1 /****************************************************************************
2  * Copyright (c) 1998-2003,2004 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 /***************************************************************************
34 * Module m_item_opt                                                        *
35 * Menus item option routines                                               *
36 ***************************************************************************/
37
38 #include "menu.priv.h"
39
40 MODULE_ID("$Id: m_item_opt.c,v 1.17 2004/12/25 21:32:54 tom Exp $")
41
42 /*---------------------------------------------------------------------------
43 |   Facility      :  libnmenu  
44 |   Function      :  int set_item_opts(ITEM *item, Item_Options opts)  
45 |   
46 |   Description   :  Set the options of the item. If there are relevant
47 |                    changes, the item is connected and the menu is posted,
48 |                    the menu will be redisplayed.
49 |
50 |   Return Values :  E_OK            - success
51 |                    E_BAD_ARGUMENT  - invalid item options
52 +--------------------------------------------------------------------------*/
53 NCURSES_EXPORT(int)
54 set_item_opts(ITEM * item, Item_Options opts)
55 {
56   T((T_CALLED("set_menu_opts(%p,%d)"), item, opts));
57
58   opts &= ALL_ITEM_OPTS;
59
60   if (opts & ~ALL_ITEM_OPTS)
61     RETURN(E_BAD_ARGUMENT);
62
63   if (item)
64     {
65       if (item->opt != opts)
66         {
67           MENU *menu = item->imenu;
68
69           item->opt = opts;
70
71           if ((!(opts & O_SELECTABLE)) && item->value)
72             item->value = FALSE;
73
74           if (menu && (menu->status & _POSTED))
75             {
76               Move_And_Post_Item(menu, item);
77               _nc_Show_Menu(menu);
78             }
79         }
80     }
81   else
82     _nc_Default_Item.opt = opts;
83
84   RETURN(E_OK);
85 }
86
87 /*---------------------------------------------------------------------------
88 |   Facility      :  libnmenu  
89 |   Function      :  int item_opts_off(ITEM *item, Item_Options opts)   
90 |   
91 |   Description   :  Switch of the options for this item.
92 |
93 |   Return Values :  E_OK            - success
94 |                    E_BAD_ARGUMENT  - invalid options
95 +--------------------------------------------------------------------------*/
96 NCURSES_EXPORT(int)
97 item_opts_off(ITEM * item, Item_Options opts)
98 {
99   ITEM *citem = item;           /* use a copy because set_item_opts must detect
100
101                                    NULL item itself to adjust its behavior */
102
103   T((T_CALLED("item_opts_off(%p,%d)"), item, opts));
104
105   if (opts & ~ALL_ITEM_OPTS)
106     RETURN(E_BAD_ARGUMENT);
107   else
108     {
109       Normalize_Item(citem);
110       opts = citem->opt & ~(opts & ALL_ITEM_OPTS);
111       returnCode(set_item_opts(item, opts));
112     }
113 }
114
115 /*---------------------------------------------------------------------------
116 |   Facility      :  libnmenu  
117 |   Function      :  int item_opts_on(ITEM *item, Item_Options opts)   
118 |   
119 |   Description   :  Switch on the options for this item.
120 |
121 |   Return Values :  E_OK            - success
122 |                    E_BAD_ARGUMENT  - invalid options
123 +--------------------------------------------------------------------------*/
124 NCURSES_EXPORT(int)
125 item_opts_on(ITEM * item, Item_Options opts)
126 {
127   ITEM *citem = item;           /* use a copy because set_item_opts must detect
128
129                                    NULL item itself to adjust its behavior */
130
131   T((T_CALLED("item_opts_on(%p,%d)"), item, opts));
132
133   opts &= ALL_ITEM_OPTS;
134   if (opts & ~ALL_ITEM_OPTS)
135     RETURN(E_BAD_ARGUMENT);
136   else
137     {
138       Normalize_Item(citem);
139       opts = citem->opt | opts;
140       returnCode(set_item_opts(item, opts));
141     }
142 }
143
144 /*---------------------------------------------------------------------------
145 |   Facility      :  libnmenu  
146 |   Function      :  Item_Options item_opts(const ITEM *item)   
147 |   
148 |   Description   :  Switch of the options for this item.
149 |
150 |   Return Values :  Items options
151 +--------------------------------------------------------------------------*/
152 NCURSES_EXPORT(Item_Options)
153 item_opts(const ITEM * item)
154 {
155   T((T_CALLED("item_opts(%p)"), item));
156   returnItemOpts(ALL_ITEM_OPTS & Normalize_Item(item)->opt);
157 }
158
159 /* m_item_opt.c ends here */