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