36a7818e249685484f6de374679aab64b8af1517
[ncurses.git] / menu / m_item_cur.c
1 /****************************************************************************
2  * Copyright (c) 1998 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 <Juergen.Pfeifer@T-Online.de> 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.9 1998/02/11 12:13:49 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 +--------------------------------------------------------------------------*/
50 int set_current_item(MENU * menu, ITEM * item)
51 {
52   if (menu && item && (item->imenu==menu))
53     {
54       if ( menu->status & _IN_DRIVER )
55         RETURN(E_BAD_STATE);
56       
57       assert( menu->curitem );
58       if (item != menu->curitem)
59         {
60           if (menu->status & _LINK_NEEDED)
61             {
62               /*
63                * Items are available, but they are not linked together.
64                * So we have to link here.
65                */
66               _nc_Link_Items(menu);
67             }
68           assert(menu->pattern);
69           Reset_Pattern(menu);
70           /* adjust the window to make item visible and update the menu */
71           Adjust_Current_Item(menu,menu->toprow,item);
72         }
73     }
74   else
75     RETURN(E_BAD_ARGUMENT);
76   
77   RETURN(E_OK);
78 }
79
80 /*---------------------------------------------------------------------------
81 |   Facility      :  libnmenu  
82 |   Function      :  ITEM *current_item(const MENU *menu)
83 |   
84 |   Description   :  Return the menus current item
85 |
86 |   Return Values :  Item pointer or NULL if failure
87 +--------------------------------------------------------------------------*/
88 ITEM *current_item(const MENU * menu) 
89 {
90   return (menu && menu->items) ? menu->curitem : (ITEM *)0;
91 }
92
93 /*---------------------------------------------------------------------------
94 |   Facility      :  libnmenu  
95 |   Function      :  int item_index(const ITEM *)
96 |   
97 |   Description   :  Return the logical index of this item.
98 |
99 |   Return Values :  The index or ERR if this is an invalid item pointer
100 +--------------------------------------------------------------------------*/
101 int item_index(const ITEM *item)
102 {
103   return (item && item->imenu) ? item->index : ERR;
104 }
105
106 /* m_item_cur.c ends here */