contrib/ncurses-5.4/menu/m_item_top.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  ****************************************************************************/
  32
  33 /***************************************************************************
  34 * Module m_item_top                                                        *
  35 * Set and get top menus item                                               *
  36 ***************************************************************************/
  37
  38 #include "menu.priv.h"
  39
  40 MODULE_ID("$Id: m_item_top.c,v 1.8 2003/11/08 20:51:53 tom Exp $")
  41
  42 /*---------------------------------------------------------------------------
  43 |   Facility      :  libnmenu
  44 |   Function      :  int set_top_row(MENU *menu, int row)
  45 |
  46 |   Description   :  Makes the specified row the top row in the menu
  47 |
  48 |   Return Values :  E_OK             - success
  49 |                    E_BAD_ARGUMENT   - not a menu pointer or invalid row
  50 |                    E_NOT_CONNECTED  - there are no items for the menu
  51 +--------------------------------------------------------------------------*/
  52 NCURSES_EXPORT(int)
  53 set_top_row (MENU * menu, int row)
  54 {
  55   ITEM *item;
  56
  57   if (menu)
  58     {
  59       if ( menu->status & _IN_DRIVER )
  60         RETURN(E_BAD_STATE);
  61       if (menu->items == (ITEM **)0)
  62         RETURN(E_NOT_CONNECTED);
  63
  64       if ((row<0) || (row > (menu->rows - menu->arows)))
  65         RETURN(E_BAD_ARGUMENT);
  66     }
  67   else
  68     RETURN(E_BAD_ARGUMENT);
  69
  70   if (row != menu->toprow)
  71     {
  72       if (menu->status & _LINK_NEEDED)
  73         _nc_Link_Items(menu);
  74
  75       item = menu->items[ (menu->opt&O_ROWMAJOR) ? (row*menu->cols) : row ];
  76       assert(menu->pattern);
  77       Reset_Pattern(menu);
  78       _nc_New_TopRow_and_CurrentItem(menu, row, item);
  79     }
  80
  81     RETURN(E_OK);
  82 }
  83
  84 /*---------------------------------------------------------------------------
  85 |   Facility      :  libnmenu
  86 |   Function      :  int top_row(const MENU *)
  87 |
  88 |   Description   :  Return the top row of the menu
  89 |
  90 |   Return Values :  The row number or ERR if there is no row
  91 +--------------------------------------------------------------------------*/
  92 NCURSES_EXPORT(int)
  93 top_row (const MENU * menu)
  94 {
  95   if (menu && menu->items && *(menu->items))
  96     {
  97       assert( (menu->toprow>=0) && (menu->toprow < menu->rows) );
  98       return menu->toprow;
  99     }
 100   else
 101     return(ERR);
 102 }
 103
 104 /* m_item_top.c ends here */