xref: /openbsd/lib/libmenu/m_item_cur.c (revision 3d8817e4)
1 /* $OpenBSD: m_item_cur.c,v 1.7 2010/01/12 23:22:08 nicm Exp $ */
2 
3 /****************************************************************************
4  * Copyright (c) 1998-2003,2004 Free Software Foundation, Inc.              *
5  *                                                                          *
6  * Permission is hereby granted, free of charge, to any person obtaining a  *
7  * copy of this software and associated documentation files (the            *
8  * "Software"), to deal in the Software without restriction, including      *
9  * without limitation the rights to use, copy, modify, merge, publish,      *
10  * distribute, distribute with modifications, sublicense, and/or sell       *
11  * copies of the Software, and to permit persons to whom the Software is    *
12  * furnished to do so, subject to the following conditions:                 *
13  *                                                                          *
14  * The above copyright notice and this permission notice shall be included  *
15  * in all copies or substantial portions of the Software.                   *
16  *                                                                          *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24  *                                                                          *
25  * Except as contained in this notice, the name(s) of the above copyright   *
26  * holders shall not be used in advertising or otherwise to promote the     *
27  * sale, use or other dealings in this Software without prior written       *
28  * authorization.                                                           *
29  ****************************************************************************/
30 
31 /****************************************************************************
32  *   Author:  Juergen Pfeifer, 1995,1997                                    *
33  ****************************************************************************/
34 
35 /***************************************************************************
36 * Module m_item_cur                                                        *
37 * Set and get current menus item                                           *
38 ***************************************************************************/
39 
40 #include "menu.priv.h"
41 
42 MODULE_ID("$Id: m_item_cur.c,v 1.7 2010/01/12 23:22:08 nicm Exp $")
43 
44 /*---------------------------------------------------------------------------
45 |   Facility      :  libnmenu
46 |   Function      :  int set_current_item(MENU *menu, const ITEM *item)
47 |
48 |   Description   :  Make the item the current item
49 |
50 |   Return Values :  E_OK                - success
51 +--------------------------------------------------------------------------*/
52 NCURSES_EXPORT(int)
53 set_current_item(MENU * menu, ITEM * item)
54 {
55   T((T_CALLED("set_current_item(%p,%p)"), menu, item));
56 
57   if (menu && item && (item->imenu == menu))
58     {
59       if (menu->status & _IN_DRIVER)
60 	RETURN(E_BAD_STATE);
61 
62       assert(menu->curitem);
63       if (item != menu->curitem)
64 	{
65 	  if (menu->status & _LINK_NEEDED)
66 	    {
67 	      /*
68 	       * Items are available, but they are not linked together.
69 	       * So we have to link here.
70 	       */
71 	      _nc_Link_Items(menu);
72 	    }
73 	  assert(menu->pattern);
74 	  Reset_Pattern(menu);
75 	  /* adjust the window to make item visible and update the menu */
76 	  Adjust_Current_Item(menu, menu->toprow, item);
77 	}
78     }
79   else
80     RETURN(E_BAD_ARGUMENT);
81 
82   RETURN(E_OK);
83 }
84 
85 /*---------------------------------------------------------------------------
86 |   Facility      :  libnmenu
87 |   Function      :  ITEM *current_item(const MENU *menu)
88 |
89 |   Description   :  Return the menus current item
90 |
91 |   Return Values :  Item pointer or NULL if failure
92 +--------------------------------------------------------------------------*/
93 NCURSES_EXPORT(ITEM *)
94 current_item(const MENU * menu)
95 {
96   T((T_CALLED("current_item(%p)"), menu));
97   returnItem((menu && menu->items) ? menu->curitem : (ITEM *) 0);
98 }
99 
100 /*---------------------------------------------------------------------------
101 |   Facility      :  libnmenu
102 |   Function      :  int item_index(const ITEM *)
103 |
104 |   Description   :  Return the logical index of this item.
105 |
106 |   Return Values :  The index or ERR if this is an invalid item pointer
107 +--------------------------------------------------------------------------*/
108 NCURSES_EXPORT(int)
109 item_index(const ITEM * item)
110 {
111   T((T_CALLED("item_index(%p)"), item));
112   returnCode((item && item->imenu) ? item->index : ERR);
113 }
114 
115 /* m_item_cur.c ends here */
116