menu/m_items.c

   1 /****************************************************************************
   2  * Copyright (c) 1998-2004,2005 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  ****************************************************************************/
  32
  33 /***************************************************************************
  34 * Module m_items                                                           *
  35 * Connect and disconnect items to and from menus                           *
  36 ***************************************************************************/
  37
  38 #include "menu.priv.h"
  39
  40 MODULE_ID("$Id: m_items.c,v 1.16 2005/01/16 01:02:23 tom Exp $")
  41
  42 /*---------------------------------------------------------------------------
  43 |   Facility      :  libnmenu
  44 |   Function      :  int set_menu_items(MENU *menu, ITEM **items)
  45 |
  46 |   Description   :  Sets the item pointer array connected to menu.
  47 |
  48 |   Return Values :  E_OK           - success
  49 |                    E_POSTED       - menu is already posted
  50 |                    E_CONNECTED    - one or more items are already connected
  51 |                                     to another menu.
  52 |                    E_BAD_ARGUMENT - An incorrect menu or item array was
  53 |                                     passed to the function
  54 +--------------------------------------------------------------------------*/
  55 NCURSES_EXPORT(int)
  56 set_menu_items(MENU * menu, ITEM ** items)
  57 {
  58   T((T_CALLED("set_menu_items(%p,%p)"), menu, items));
  59
  60   if (!menu || (items && !(*items)))
  61     RETURN(E_BAD_ARGUMENT);
  62
  63   if (menu->status & _POSTED)
  64     RETURN(E_POSTED);
  65
  66   if (menu->items)
  67     _nc_Disconnect_Items(menu);
  68
  69   if (items)
  70     {
  71       if (!_nc_Connect_Items(menu, items))
  72         RETURN(E_CONNECTED);
  73     }
  74
  75   menu->items = items;
  76   RETURN(E_OK);
  77 }
  78
  79 /*---------------------------------------------------------------------------
  80 |   Facility      :  libnmenu
  81 |   Function      :  ITEM **menu_items(const MENU *menu)
  82 |
  83 |   Description   :  Returns a pointer to the item pointer array of the menu
  84 |
  85 |   Return Values :  NULL on error
  86 +--------------------------------------------------------------------------*/
  87 NCURSES_EXPORT(ITEM **)
  88 menu_items(const MENU * menu)
  89 {
  90   T((T_CALLED("menu_items(%p)"), menu));
  91   returnItemPtr(menu ? menu->items : (ITEM **) 0);
  92 }
  93
  94 /*---------------------------------------------------------------------------
  95 |   Facility      :  libnmenu
  96 |   Function      :  int item_count(const MENU *menu)
  97 |
  98 |   Description   :  Get the number of items connected to the menu. If the
  99 |                    menu pointer is NULL we return -1.
 100 |
 101 |   Return Values :  Number of items or -1 to indicate error.
 102 +--------------------------------------------------------------------------*/
 103 NCURSES_EXPORT(int)
 104 item_count(const MENU * menu)
 105 {
 106   T((T_CALLED("item_count(%p)"), menu));
 107   returnCode(menu ? menu->nitems : -1);
 108 }
 109
 110 /* m_items.c ends here */