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