xref: /openbsd/lib/libmenu/m_item_top.c (revision 09467b48)
1 /* $OpenBSD: m_item_top.c,v 1.5 2010/01/12 23:22:08 nicm Exp $ */
2 
3 /****************************************************************************
4  * Copyright (c) 1998-2003,2004 Free Software Foundation, Inc.              *
5  *                                                                          *
6  * Permission is hereby granted, free of charge, to any person obtaining a  *
7  * copy of this software and associated documentation files (the            *
8  * "Software"), to deal in the Software without restriction, including      *
9  * without limitation the rights to use, copy, modify, merge, publish,      *
10  * distribute, distribute with modifications, sublicense, and/or sell       *
11  * copies of the Software, and to permit persons to whom the Software is    *
12  * furnished to do so, subject to the following conditions:                 *
13  *                                                                          *
14  * The above copyright notice and this permission notice shall be included  *
15  * in all copies or substantial portions of the Software.                   *
16  *                                                                          *
17  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
18  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
19  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
20  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
21  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
22  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
23  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
24  *                                                                          *
25  * Except as contained in this notice, the name(s) of the above copyright   *
26  * holders shall not be used in advertising or otherwise to promote the     *
27  * sale, use or other dealings in this Software without prior written       *
28  * authorization.                                                           *
29  ****************************************************************************/
30 
31 /****************************************************************************
32  *   Author:  Juergen Pfeifer, 1995,1997                                    *
33  ****************************************************************************/
34 
35 /***************************************************************************
36 * Module m_item_top                                                        *
37 * Set and get top menus item                                               *
38 ***************************************************************************/
39 
40 #include "menu.priv.h"
41 
42 MODULE_ID("$Id: m_item_top.c,v 1.5 2010/01/12 23:22:08 nicm Exp $")
43 
44 /*---------------------------------------------------------------------------
45 |   Facility      :  libnmenu
46 |   Function      :  int set_top_row(MENU *menu, int row)
47 |
48 |   Description   :  Makes the specified row the top row in the menu
49 |
50 |   Return Values :  E_OK             - success
51 |                    E_BAD_ARGUMENT   - not a menu pointer or invalid row
52 |                    E_NOT_CONNECTED  - there are no items for the menu
53 +--------------------------------------------------------------------------*/
54 NCURSES_EXPORT(int)
55 set_top_row(MENU * menu, int row)
56 {
57   ITEM *item;
58 
59   T((T_CALLED("set_top_row(%p,%d)"), menu, row));
60 
61   if (menu)
62     {
63       if (menu->status & _IN_DRIVER)
64 	RETURN(E_BAD_STATE);
65       if (menu->items == (ITEM **) 0)
66 	RETURN(E_NOT_CONNECTED);
67 
68       if ((row < 0) || (row > (menu->rows - menu->arows)))
69 	RETURN(E_BAD_ARGUMENT);
70     }
71   else
72     RETURN(E_BAD_ARGUMENT);
73 
74   if (row != menu->toprow)
75     {
76       if (menu->status & _LINK_NEEDED)
77 	_nc_Link_Items(menu);
78 
79       item = menu->items[(menu->opt & O_ROWMAJOR) ? (row * menu->cols) : row];
80       assert(menu->pattern);
81       Reset_Pattern(menu);
82       _nc_New_TopRow_and_CurrentItem(menu, row, item);
83     }
84 
85   RETURN(E_OK);
86 }
87 
88 /*---------------------------------------------------------------------------
89 |   Facility      :  libnmenu
90 |   Function      :  int top_row(const MENU *)
91 |
92 |   Description   :  Return the top row of the menu
93 |
94 |   Return Values :  The row number or ERR if there is no row
95 +--------------------------------------------------------------------------*/
96 NCURSES_EXPORT(int)
97 top_row(const MENU * menu)
98 {
99   T((T_CALLED("top_row(%p)"), menu));
100   if (menu && menu->items && *(menu->items))
101     {
102       assert((menu->toprow >= 0) && (menu->toprow < menu->rows));
103       returnCode(menu->toprow);
104     }
105   else
106     returnCode(ERR);
107 }
108 
109 /* m_item_top.c ends here */
110