ncurses 5.4
[ncurses.git] / menu / m_item_opt.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  ****************************************************************************/
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.14 2003/11/08 20:50:19 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   opts &= ALL_ITEM_OPTS;
57
58   if (opts & ~ALL_ITEM_OPTS)
59     RETURN(E_BAD_ARGUMENT);
60   
61   if (item)
62     {
63       if (item->opt != opts)
64         {               
65           MENU *menu = item->imenu;
66           
67           item->opt = opts;
68           
69           if ((!(opts & O_SELECTABLE)) && item->value)
70             item->value = FALSE;
71           
72           if (menu && (menu->status & _POSTED))
73             {
74               Move_And_Post_Item( menu, item );
75               _nc_Show_Menu(menu);
76             }
77         }
78     }
79   else
80     _nc_Default_Item.opt = opts;
81   
82   RETURN(E_OK);
83 }
84
85 /*---------------------------------------------------------------------------
86 |   Facility      :  libnmenu  
87 |   Function      :  int item_opts_off(ITEM *item, Item_Options opts)   
88 |   
89 |   Description   :  Switch of the options for this item.
90 |
91 |   Return Values :  E_OK            - success
92 |                    E_BAD_ARGUMENT  - invalid options
93 +--------------------------------------------------------------------------*/
94 NCURSES_EXPORT(int)
95 item_opts_off (ITEM *item, Item_Options  opts)
96
97   ITEM *citem = item; /* use a copy because set_item_opts must detect
98                          NULL item itself to adjust its behavior */
99
100   if (opts & ~ALL_ITEM_OPTS)
101     RETURN(E_BAD_ARGUMENT);
102   else
103     {
104       Normalize_Item(citem);    
105       opts = citem->opt & ~(opts & ALL_ITEM_OPTS);
106       return set_item_opts( item, opts );
107     }
108 }
109
110 /*---------------------------------------------------------------------------
111 |   Facility      :  libnmenu  
112 |   Function      :  int item_opts_on(ITEM *item, Item_Options opts)   
113 |   
114 |   Description   :  Switch on the options for this item.
115 |
116 |   Return Values :  E_OK            - success
117 |                    E_BAD_ARGUMENT  - invalid options
118 +--------------------------------------------------------------------------*/
119 NCURSES_EXPORT(int)
120 item_opts_on (ITEM *item, Item_Options opts)
121 {
122   ITEM *citem = item; /* use a copy because set_item_opts must detect
123                          NULL item itself to adjust its behavior */
124   
125   opts &= ALL_ITEM_OPTS;
126   if (opts & ~ALL_ITEM_OPTS)
127     RETURN(E_BAD_ARGUMENT);
128   else
129     {
130       Normalize_Item(citem);
131       opts = citem->opt | opts;
132       return set_item_opts( item, opts );
133     }
134 }
135
136 /*---------------------------------------------------------------------------
137 |   Facility      :  libnmenu  
138 |   Function      :  Item_Options item_opts(const ITEM *item)   
139 |   
140 |   Description   :  Switch of the options for this item.
141 |
142 |   Return Values :  Items options
143 +--------------------------------------------------------------------------*/
144 NCURSES_EXPORT(Item_Options)
145 item_opts (const ITEM * item)
146 {
147   return (ALL_ITEM_OPTS & Normalize_Item(item)->opt);
148 }
149
150 /* m_item_opt.c ends here */