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