blob: 68303c7676b5e6b2395d64c27391dc9998d10da7 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301/****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -04002 * Copyright 2020,2021 Thomas E. Dickey *
3 * Copyright 1998-2004,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05304 * *
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
micky3879b9f5e72025-07-08 18:04:53 -040041MODULE_ID("$Id: m_item_top.c,v 1.16 2021/06/17 21:11:08 tom Exp $")
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053042
43/*---------------------------------------------------------------------------
micky3879b9f5e72025-07-08 18:04:53 -040044| Facility : libnmenu
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053045| Function : int set_top_row(MENU *menu, int row)
micky3879b9f5e72025-07-08 18:04:53 -040046|
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053047| 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+--------------------------------------------------------------------------*/
micky3879b9f5e72025-07-08 18:04:53 -040053MENU_EXPORT(int)
54set_top_row(MENU *menu, int row)
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053055{
Steve Kondikae271bc2015-11-15 02:50:53 +010056 T((T_CALLED("set_top_row(%p,%d)"), (void *)menu, row));
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053057
58 if (menu)
59 {
60 if (menu->status & _IN_DRIVER)
61 RETURN(E_BAD_STATE);
micky3879b9f5e72025-07-08 18:04:53 -040062 if (menu->items == (ITEM **)0)
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053063 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 {
micky3879b9f5e72025-07-08 18:04:53 -040073 ITEM *item;
74
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053075 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/*---------------------------------------------------------------------------
micky3879b9f5e72025-07-08 18:04:53 -040088| Facility : libnmenu
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053089| Function : int top_row(const MENU *)
micky3879b9f5e72025-07-08 18:04:53 -040090|
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053091| Description : Return the top row of the menu
92|
93| Return Values : The row number or ERR if there is no row
94+--------------------------------------------------------------------------*/
micky3879b9f5e72025-07-08 18:04:53 -040095MENU_EXPORT(int)
96top_row(const MENU *menu)
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053097{
Steve Kondikae271bc2015-11-15 02:50:53 +010098 T((T_CALLED("top_row(%p)"), (const void *)menu));
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053099 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 */