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