ncurses 5.4
[ncurses.git] / menu / m_items.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_items                                                           *
35 * Connect and disconnect items to and from menus                           *
36 ***************************************************************************/
37
38 #include "menu.priv.h"
39
40 MODULE_ID("$Id: m_items.c,v 1.12 2003/11/08 20:50:58 tom Exp $")
41
42 /*---------------------------------------------------------------------------
43 |   Facility      :  libnmenu  
44 |   Function      :  int set_menu_items(MENU *menu, ITEM **items)
45 |   
46 |   Description   :  Sets the item pointer array connected to menu.
47 |
48 |   Return Values :  E_OK           - success
49 |                    E_POSTED       - menu is already posted
50 |                    E_CONNECTED    - one or more items are already connected
51 |                                     to another menu.
52 |                    E_BAD_ARGUMENT - An incorrect menu or item array was
53 |                                     passed to the function
54 +--------------------------------------------------------------------------*/
55 NCURSES_EXPORT(int)
56 set_menu_items (MENU * menu, ITEM ** items)
57 {
58   if (!menu || (items && !(*items)))
59     RETURN(E_BAD_ARGUMENT);
60   
61   if ( menu->status & _POSTED )
62     RETURN(E_POSTED);
63   
64   if (menu->items)
65     _nc_Disconnect_Items(menu);
66   
67   if (items)
68     {
69       if(!_nc_Connect_Items( menu, items )) 
70         RETURN(E_CONNECTED);
71     }
72   
73   menu->items = items;
74   RETURN(E_OK);
75 }               
76
77 /*---------------------------------------------------------------------------
78 |   Facility      :  libnmenu  
79 |   Function      :  ITEM **menu_items(const MENU *menu)
80 |   
81 |   Description   :  Returns a pointer to the item pointer array of the menu
82 |
83 |   Return Values :  NULL on error
84 +--------------------------------------------------------------------------*/
85 NCURSES_EXPORT(ITEM **)
86 menu_items (const MENU *menu)
87 {
88   return(menu ? menu->items : (ITEM **)0);
89 }
90
91 /*---------------------------------------------------------------------------
92 |   Facility      :  libnmenu  
93 |   Function      :  int item_count(const MENU *menu)
94 |   
95 |   Description   :  Get the number of items connected to the menu. If the
96 |                    menu pointer is NULL we return -1.         
97 |
98 |   Return Values :  Number of items or -1 to indicate error.
99 +--------------------------------------------------------------------------*/
100 NCURSES_EXPORT(int)
101 item_count (const MENU *menu)
102 {
103   return(menu ? menu->nitems : -1);
104 }
105
106 /* m_items.c ends here */