ncurses 6.2 - patch 20210522
[ncurses.git] / menu / m_item_top.c
1 /****************************************************************************
2  * Copyright 2020,2021 Thomas E. Dickey                                     *
3  * Copyright 1998-2004,2010 Free Software Foundation, Inc.                  *
4  *                                                                          *
5  * Permission is hereby granted, free of charge, to any person obtaining a  *
6  * copy of this software and associated documentation files (the            *
7  * "Software"), to deal in the Software without restriction, including      *
8  * without limitation the rights to use, copy, modify, merge, publish,      *
9  * distribute, distribute with modifications, sublicense, and/or sell       *
10  * copies of the Software, and to permit persons to whom the Software is    *
11  * furnished to do so, subject to the following conditions:                 *
12  *                                                                          *
13  * The above copyright notice and this permission notice shall be included  *
14  * in all copies or substantial portions of the Software.                   *
15  *                                                                          *
16  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23  *                                                                          *
24  * Except as contained in this notice, the name(s) of the above copyright   *
25  * holders shall not be used in advertising or otherwise to promote the     *
26  * sale, use or other dealings in this Software without prior written       *
27  * authorization.                                                           *
28  ****************************************************************************/
29
30 /****************************************************************************
31  *   Author:  Juergen Pfeifer, 1995,1997                                    *
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.15 2021/03/27 23:46:29 tom Exp $")
42
43 /*---------------------------------------------------------------------------
44 |   Facility      :  libnmenu  
45 |   Function      :  int set_top_row(MENU *menu, int row)
46 |   
47 |   Description   :  Makes the specified 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 MENU_EXPORT(int)
54 set_top_row(MENU *menu, int row)
55 {
56   T((T_CALLED("set_top_row(%p,%d)"), (void *)menu, row));
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       ITEM *item;
74
75       if (menu->status & _LINK_NEEDED)
76         _nc_Link_Items(menu);
77
78       item = menu->items[(menu->opt & O_ROWMAJOR) ? (row * menu->cols) : row];
79       assert(menu->pattern);
80       Reset_Pattern(menu);
81       _nc_New_TopRow_and_CurrentItem(menu, row, item);
82     }
83
84   RETURN(E_OK);
85 }
86
87 /*---------------------------------------------------------------------------
88 |   Facility      :  libnmenu  
89 |   Function      :  int top_row(const MENU *)
90 |   
91 |   Description   :  Return the top row of the menu
92 |
93 |   Return Values :  The row number or ERR if there is no row
94 +--------------------------------------------------------------------------*/
95 MENU_EXPORT(int)
96 top_row(const MENU *menu)
97 {
98   T((T_CALLED("top_row(%p)"), (const void *)menu));
99   if (menu && menu->items && *(menu->items))
100     {
101       assert((menu->toprow >= 0) && (menu->toprow < menu->rows));
102       returnCode(menu->toprow);
103     }
104   else
105     returnCode(ERR);
106 }
107
108 /* m_item_top.c ends here */