1 /****************************************************************************
2 * Copyright (c) 1998-2004,2010 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_cur *
35 * Set and get current menus item *
36 ***************************************************************************/
37
38 #include "menu.priv.h"
39
40 MODULE_ID("$Id: m_item_cur.c,v 1.18 2010/01/23 21:20:10 tom Exp $")
41
42 /*---------------------------------------------------------------------------
43 | Facility : libnmenu
44 | Function : int set_current_item(MENU *menu, const ITEM *item)
45 |
46 | Description : Make the item the current item
47 |
48 | Return Values : E_OK - success
49 +--------------------------------------------------------------------------*/
NCURSES_EXPORT(int)50 NCURSES_EXPORT(int)
51 set_current_item(MENU * menu, ITEM * item)
52 {
53 T((T_CALLED("set_current_item(%p,%p)"), (void *)menu, (void *)item));
54
55 if (menu && item && (item->imenu == menu))
56 {
57 if (menu->status & _IN_DRIVER)
58 RETURN(E_BAD_STATE);
59
60 assert(menu->curitem);
61 if (item != menu->curitem)
62 {
63 if (menu->status & _LINK_NEEDED)
64 {
65 /*
66 * Items are available, but they are not linked together.
67 * So we have to link here.
68 */
69 _nc_Link_Items(menu);
70 }
71 assert(menu->pattern);
72 Reset_Pattern(menu);
73 /* adjust the window to make item visible and update the menu */
74 Adjust_Current_Item(menu, menu->toprow, item);
75 }
76 }
77 else
78 RETURN(E_BAD_ARGUMENT);
79
80 RETURN(E_OK);
81 }
82
83 /*---------------------------------------------------------------------------
84 | Facility : libnmenu
85 | Function : ITEM *current_item(const MENU *menu)
86 |
87 | Description : Return the menus current item
88 |
89 | Return Values : Item pointer or NULL if failure
90 +--------------------------------------------------------------------------*/
91 NCURSES_EXPORT(ITEM *)
current_item(const MENU * menu)92 current_item(const MENU * menu)
93 {
94 T((T_CALLED("current_item(%p)"), (const void *)menu));
95 returnItem((menu && menu->items) ? menu->curitem : (ITEM *) 0);
96 }
97
98 /*---------------------------------------------------------------------------
99 | Facility : libnmenu
100 | Function : int item_index(const ITEM *)
101 |
102 | Description : Return the logical index of this item.
103 |
104 | Return Values : The index or ERR if this is an invalid item pointer
105 +--------------------------------------------------------------------------*/
106 NCURSES_EXPORT(int)
item_index(const ITEM * item)107 item_index(const ITEM * item)
108 {
109 T((T_CALLED("item_index(%p)"), (const void *)item));
110 returnCode((item && item->imenu) ? item->index : ERR);
111 }
112
113 /* m_item_cur.c ends here */
114