ncurses 5.7 - patch 20091010
[ncurses.git] / menu / m_item_cur.c
index 9881666f577ec907e482942528fa7f1dc4272789..dac12ed91c5e65ec5feca3aa1f68503add41415b 100644 (file)
@@ -1,33 +1,43 @@
-/*-----------------------------------------------------------------------------+
-|           The ncurses menu library is  Copyright (C) 1995-1997               |
-|             by Juergen Pfeifer <Juergen.Pfeifer@T-Online.de>                 |
-|                          All Rights Reserved.                                |
-|                                                                              |
-| Permission to use, copy, modify, and distribute this software and its        |
-| documentation for any purpose and without fee is hereby granted, provided    |
-| that the above copyright notice appear in all copies and that both that      |
-| copyright notice and this permission notice appear in supporting             |
-| documentation, and that the name of the above listed copyright holder(s) not |
-| be used in advertising or publicity pertaining to distribution of the        |
-| software without specific, written prior permission.                         | 
-|                                                                              |
-| THE ABOVE LISTED COPYRIGHT HOLDER(S) DISCLAIM ALL WARRANTIES WITH REGARD TO  |
-| THIS SOFTWARE, INCLUDING ALL IMPLIED WARRANTIES OF MERCHANTABILITY AND FIT-  |
-| NESS, IN NO EVENT SHALL THE ABOVE LISTED COPYRIGHT HOLDER(S) BE LIABLE FOR   |
-| ANY SPECIAL, INDIRECT OR CONSEQUENTIAL DAMAGES OR ANY DAMAGES WHATSOEVER RE- |
-| SULTING FROM LOSS OF USE, DATA OR PROFITS, WHETHER IN AN ACTION OF CONTRACT, |
-| NEGLIGENCE OR OTHER TORTIOUS ACTION, ARISING OUT OF OR IN CONNECTION WITH    |
-| THE USE OR PERFORMANCE OF THIS SOFTWARE.                                     |
-+-----------------------------------------------------------------------------*/
+/****************************************************************************
+ * Copyright (c) 1998-2003,2004 Free Software Foundation, Inc.              *
+ *                                                                          *
+ * Permission is hereby granted, free of charge, to any person obtaining a  *
+ * copy of this software and associated documentation files (the            *
+ * "Software"), to deal in the Software without restriction, including      *
+ * without limitation the rights to use, copy, modify, merge, publish,      *
+ * distribute, distribute with modifications, sublicense, and/or sell       *
+ * copies of the Software, and to permit persons to whom the Software is    *
+ * furnished to do so, subject to the following conditions:                 *
+ *                                                                          *
+ * The above copyright notice and this permission notice shall be included  *
+ * in all copies or substantial portions of the Software.                   *
+ *                                                                          *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
+ *                                                                          *
+ * Except as contained in this notice, the name(s) of the above copyright   *
+ * holders shall not be used in advertising or otherwise to promote the     *
+ * sale, use or other dealings in this Software without prior written       *
+ * authorization.                                                           *
+ ****************************************************************************/
+
+/****************************************************************************
+ *   Author:  Juergen Pfeifer, 1995,1997                                    *
+ ****************************************************************************/
 
 /***************************************************************************
-* Module menu_item_cur                                                     *
+* Module m_item_cur                                                        *
 * Set and get current menus item                                           *
 ***************************************************************************/
 
 #include "menu.priv.h"
 
-MODULE_ID("$Id: m_item_cur.c,v 1.7 1997/05/01 16:47:26 juergen Exp $")
+MODULE_ID("$Id: m_item_cur.c,v 1.17 2004/12/25 21:57:38 tom Exp $")
 
 /*---------------------------------------------------------------------------
 |   Facility      :  libnmenu  
@@ -37,14 +47,17 @@ MODULE_ID("$Id: m_item_cur.c,v 1.7 1997/05/01 16:47:26 juergen Exp $")
 |
 |   Return Values :  E_OK                - success
 +--------------------------------------------------------------------------*/
-int set_current_item(MENU * menu, ITEM * item)
+NCURSES_EXPORT(int)
+set_current_item(MENU * menu, ITEM * item)
 {
-  if (menu && item && (item->imenu==menu))
+  T((T_CALLED("set_current_item(%p,%p)"), menu, item));
+
+  if (menu && item && (item->imenu == menu))
     {
-      if ( menu->status & _IN_DRIVER )
+      if (menu->status & _IN_DRIVER)
        RETURN(E_BAD_STATE);
-      
-      assert( menu->curitem );
+
+      assert(menu->curitem);
       if (item != menu->curitem)
        {
          if (menu->status & _LINK_NEEDED)
@@ -58,12 +71,12 @@ int set_current_item(MENU * menu, ITEM * item)
          assert(menu->pattern);
          Reset_Pattern(menu);
          /* adjust the window to make item visible and update the menu */
-         Adjust_Current_Item(menu,menu->toprow,item);
+         Adjust_Current_Item(menu, menu->toprow, item);
        }
     }
   else
     RETURN(E_BAD_ARGUMENT);
-  
+
   RETURN(E_OK);
 }
 
@@ -75,9 +88,11 @@ int set_current_item(MENU * menu, ITEM * item)
 |
 |   Return Values :  Item pointer or NULL if failure
 +--------------------------------------------------------------------------*/
-ITEM *current_item(const MENU * menu) 
+NCURSES_EXPORT(ITEM *)
+current_item(const MENU * menu)
 {
-  return (menu && menu->items) ? menu->curitem : (ITEM *)0;
+  T((T_CALLED("current_item(%p)"), menu));
+  returnItem((menu && menu->items) ? menu->curitem : (ITEM *) 0);
 }
 
 /*---------------------------------------------------------------------------
@@ -88,69 +103,11 @@ ITEM *current_item(const MENU * menu)
 |
 |   Return Values :  The index or ERR if this is an invalid item pointer
 +--------------------------------------------------------------------------*/
-int item_index(const ITEM *item)
-{
-  return (item && item->imenu) ? item->index : ERR;
-}
-
-/*---------------------------------------------------------------------------
-|   Facility      :  libnmenu  
-|   Function      :  int set_top_row(MENU *menu, int row)
-|   
-|   Description   :  Makes the speified row the top row in the menu
-|
-|   Return Values :  E_OK             - success
-|                    E_BAD_ARGUMENT   - not a menu pointer or invalid row
-|                    E_NOT_CONNECTED  - there are no items for the menu
-+--------------------------------------------------------------------------*/
-int set_top_row(MENU * menu, int row)
-{
-  ITEM *item;
-  
-  if (menu)
-    {
-      if ( menu->status & _IN_DRIVER )
-       RETURN(E_BAD_STATE);
-      if (menu->items == (ITEM **)0)
-       RETURN(E_NOT_CONNECTED);
-      
-      if ((row<0) || (row > (menu->rows - menu->arows)))
-       RETURN(E_BAD_ARGUMENT);
-    }
-  else
-    RETURN(E_BAD_ARGUMENT);
-  
-  if (row != menu->toprow)
-    {
-      if (menu->status & _LINK_NEEDED) 
-       _nc_Link_Items(menu);
-      
-      item = menu->items[ (menu->opt&O_ROWMAJOR) ? (row*menu->cols) : row ];
-      assert(menu->pattern);
-      Reset_Pattern(menu);
-      _nc_New_TopRow_and_CurrentItem(menu, row, item);
-    }
-  
-    RETURN(E_OK);
-}
-
-/*---------------------------------------------------------------------------
-|   Facility      :  libnmenu  
-|   Function      :  int top_row(const MENU *)
-|   
-|   Description   :  Return the top row of the menu
-|
-|   Return Values :  The row number or ERR if there is no row
-+--------------------------------------------------------------------------*/
-int top_row(const MENU * menu)
+NCURSES_EXPORT(int)
+item_index(const ITEM * item)
 {
-  if (menu && menu->items && *(menu->items))
-    {
-      assert( (menu->toprow>=0) && (menu->toprow < menu->rows) );
-      return menu->toprow;
-    }
-  else
-    return(ERR);
+  T((T_CALLED("item_index(%p)"), item));
+  returnCode((item && item->imenu) ? item->index : ERR);
 }
 
 /* m_item_cur.c ends here */