ncurses 5.3
[ncurses.git] / menu / m_item_val.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 /***************************************************************************
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.10 2002/07/06 15:22:16 juergen Exp $")
42
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu  
45 |   Function      :  int set_item_value(ITEM *item, int value)
46 |   
47 |   Description   :  Programmatically set the items 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 NCURSES_EXPORT(int)
57 set_item_value (ITEM *item, bool value)
58 {
59   MENU *menu;
60   
61   if (item)
62     {
63       menu = item->imenu;
64       
65       if ((!(item->opt & O_SELECTABLE)) ||
66           (menu && (menu->opt & O_ONEVALUE))) 
67         RETURN(E_REQUEST_DENIED);
68       
69       if (item->value ^ value)
70         {
71           item->value = value ? TRUE : FALSE;
72           if (menu)
73             {
74               if (menu->status & _POSTED)
75                 {
76                   Move_And_Post_Item(menu,item);
77                   _nc_Show_Menu(menu);
78                 }
79             }
80         }
81     }
82   else
83     _nc_Default_Item.value = value;
84   
85   RETURN(E_OK);
86 }
87
88 /*---------------------------------------------------------------------------
89 |   Facility      :  libnmenu  
90 |   Function      :  bool item_value(const ITEM *item)
91 |   
92 |   Description   :  Return the selection value of the item
93 |
94 |   Return Values :  TRUE   - if item is selected
95 |                    FALSE  - if item is not selected
96 +--------------------------------------------------------------------------*/
97 NCURSES_EXPORT(bool)
98 item_value (const ITEM *item)
99 {
100   return ((Normalize_Item(item)->value) ? TRUE : FALSE);
101 }
102
103 /* m_item_val.c ends here */