7268a0e49f15440222534c98026c8c05abe97266
[ncurses.git] / menu / m_item_top.c
1 /****************************************************************************
2  * Copyright (c) 1998-2003,2004 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.10 2004/12/11 23:29:34 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   T((T_CALLED("set_top_row(%p,%d)"), menu, row));
58
59   if (menu)
60     {
61       if (menu->status & _IN_DRIVER)
62         RETURN(E_BAD_STATE);
63       if (menu->items == (ITEM **) 0)
64         RETURN(E_NOT_CONNECTED);
65
66       if ((row < 0) || (row > (menu->rows - menu->arows)))
67         RETURN(E_BAD_ARGUMENT);
68     }
69   else
70     RETURN(E_BAD_ARGUMENT);
71
72   if (row != menu->toprow)
73     {
74       if (menu->status & _LINK_NEEDED)
75         _nc_Link_Items(menu);
76
77       item = menu->items[(menu->opt & O_ROWMAJOR) ? (row * menu->cols) : row];
78       assert(menu->pattern);
79       Reset_Pattern(menu);
80       _nc_New_TopRow_and_CurrentItem(menu, row, item);
81     }
82
83   RETURN(E_OK);
84 }
85
86 /*---------------------------------------------------------------------------
87 |   Facility      :  libnmenu  
88 |   Function      :  int top_row(const MENU *)
89 |   
90 |   Description   :  Return the top row of the menu
91 |
92 |   Return Values :  The row number or ERR if there is no row
93 +--------------------------------------------------------------------------*/
94 NCURSES_EXPORT(int)
95 top_row(const MENU * menu)
96 {
97   T((T_CALLED("top_row(%p)"), menu));
98   if (menu && menu->items && *(menu->items))
99     {
100       assert((menu->toprow >= 0) && (menu->toprow < menu->rows));
101       returnCode(menu->toprow);
102     }
103   else
104     returnCode(ERR);
105 }
106
107 /* m_item_top.c ends here */