ncurses 6.2 - patch 20210522
[ncurses.git] / menu / m_item_val.c
1 /****************************************************************************
2  * Copyright 2020,2021 Thomas E. Dickey                                     *
3  * Copyright 1998-2004,2010 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *   Author:  Juergen Pfeifer, 1995,1997                                    *
32  ****************************************************************************/
33
34 /***************************************************************************
35 * Module m_item_val                                                        *
36 * Set and get menus item values                                            *
37 ***************************************************************************/
38
39 #include "menu.priv.h"
40
41 MODULE_ID("$Id: m_item_val.c,v 1.19 2021/03/27 23:46:29 tom Exp $")
42
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu  
45 |   Function      :  int set_item_value(ITEM *item, int value)
46 |   
47 |   Description   :  Programmatically set the item's selection value. This is
48 |                    only allowed if the item is selectable at all and if
49 |                    it is not connected to a single-valued menu.
50 |                    If the item is connected to a posted menu, the menu
51 |                    will be redisplayed.  
52 |
53 |   Return Values :  E_OK              - success
54 |                    E_REQUEST_DENIED  - not selectable or single valued menu
55 +--------------------------------------------------------------------------*/
56 MENU_EXPORT(int)
57 set_item_value(ITEM *item, bool value)
58 {
59   T((T_CALLED("set_item_value(%p,%d)"), (void *)item, value));
60   if (item)
61     {
62       MENU *menu = item->imenu;
63
64       if ((!(item->opt & O_SELECTABLE)) ||
65           (menu && (menu->opt & O_ONEVALUE)))
66         RETURN(E_REQUEST_DENIED);
67
68       if (item->value ^ value)
69         {
70           item->value = value ? TRUE : FALSE;
71           if (menu)
72             {
73               if (menu->status & _POSTED)
74                 {
75                   Move_And_Post_Item(menu, item);
76                   _nc_Show_Menu(menu);
77                 }
78             }
79         }
80     }
81   else
82     _nc_Default_Item.value = value;
83
84   RETURN(E_OK);
85 }
86
87 /*---------------------------------------------------------------------------
88 |   Facility      :  libnmenu  
89 |   Function      :  bool item_value(const ITEM *item)
90 |   
91 |   Description   :  Return the selection value of the item
92 |
93 |   Return Values :  TRUE   - if item is selected
94 |                    FALSE  - if item is not selected
95 +--------------------------------------------------------------------------*/
96 MENU_EXPORT(bool)
97 item_value(const ITEM *item)
98 {
99   T((T_CALLED("item_value(%p)"), (const void *)item));
100   returnBool((Normalize_Item(item)->value) ? TRUE : FALSE);
101 }
102
103 /* m_item_val.c ends here */