1*b618a1eeSThomas Cort.\" $NetBSD: menu_item_current.3,v 1.9 2003/04/16 13:35:10 wiz Exp $ 2*b618a1eeSThomas Cort.\" 3*b618a1eeSThomas Cort.\" Copyright (c) 1999 4*b618a1eeSThomas Cort.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au 5*b618a1eeSThomas Cort.\" 6*b618a1eeSThomas Cort.\" This code is donated to The NetBSD Foundation by the author. 7*b618a1eeSThomas Cort.\" 8*b618a1eeSThomas Cort.\" Redistribution and use in source and binary forms, with or without 9*b618a1eeSThomas Cort.\" modification, are permitted provided that the following conditions 10*b618a1eeSThomas Cort.\" are met: 11*b618a1eeSThomas Cort.\" 1. Redistributions of source code must retain the above copyright 12*b618a1eeSThomas Cort.\" notice, this list of conditions and the following disclaimer. 13*b618a1eeSThomas Cort.\" 2. Redistributions in binary form must reproduce the above copyright 14*b618a1eeSThomas Cort.\" notice, this list of conditions and the following disclaimer in the 15*b618a1eeSThomas Cort.\" documentation and/or other materials provided with the distribution. 16*b618a1eeSThomas Cort.\" 3. The name of the Author may not be used to endorse or promote 17*b618a1eeSThomas Cort.\" products derived from this software without specific prior written 18*b618a1eeSThomas Cort.\" permission. 19*b618a1eeSThomas Cort.\" 20*b618a1eeSThomas Cort.\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND 21*b618a1eeSThomas Cort.\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE 22*b618a1eeSThomas Cort.\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE 23*b618a1eeSThomas Cort.\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE 24*b618a1eeSThomas Cort.\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL 25*b618a1eeSThomas Cort.\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS 26*b618a1eeSThomas Cort.\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION) 27*b618a1eeSThomas Cort.\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT 28*b618a1eeSThomas Cort.\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY 29*b618a1eeSThomas Cort.\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF 30*b618a1eeSThomas Cort.\" SUCH DAMAGE. 31*b618a1eeSThomas Cort.\" 32*b618a1eeSThomas Cort.Dd September 10, 1999 33*b618a1eeSThomas Cort.Dt MENU_ITEM_CURRENT 3 34*b618a1eeSThomas Cort.Os 35*b618a1eeSThomas Cort.Sh NAME 36*b618a1eeSThomas Cort.Nm current_item , 37*b618a1eeSThomas Cort.Nm item_index , 38*b618a1eeSThomas Cort.Nm set_current_item , 39*b618a1eeSThomas Cort.Nm set_top_row 40*b618a1eeSThomas Cort.Nm top_row 41*b618a1eeSThomas Cort.Nd get or set item pointers or top row 42*b618a1eeSThomas Cort.Sh LIBRARY 43*b618a1eeSThomas Cort.Lb libmenu 44*b618a1eeSThomas Cort.Sh SYNOPSIS 45*b618a1eeSThomas Cort.In menu.h 46*b618a1eeSThomas Cort.Ft ITEM * 47*b618a1eeSThomas Cort.Fn current_item "MENU *menu" 48*b618a1eeSThomas Cort.Ft int 49*b618a1eeSThomas Cort.Fn item_index "ITEM *item" 50*b618a1eeSThomas Cort.Ft int 51*b618a1eeSThomas Cort.Fn set_current_item "MENU *menu" "ITEM *item" 52*b618a1eeSThomas Cort.Ft int 53*b618a1eeSThomas Cort.Fn set_top_row "MENU *menu" "int row" 54*b618a1eeSThomas Cort.Ft int 55*b618a1eeSThomas Cort.Fn top_row "MENU *menu" 56*b618a1eeSThomas Cort.Sh DESCRIPTION 57*b618a1eeSThomas CortThe 58*b618a1eeSThomas Cort.Fn current_item 59*b618a1eeSThomas Cortreturns a pointer to the current menu item. 60*b618a1eeSThomas CortThe 61*b618a1eeSThomas Cort.Fn set_current_item 62*b618a1eeSThomas Cortcan be used to set this to the item give. 63*b618a1eeSThomas CortThe 64*b618a1eeSThomas Cort.Fn item_index 65*b618a1eeSThomas Cortfunction returns the index number in the array of items for the item 66*b618a1eeSThomas Cortpointed to by the 67*b618a1eeSThomas Cort.Fa item 68*b618a1eeSThomas Cortparameter. 69*b618a1eeSThomas CortThe 70*b618a1eeSThomas Cort.Fn set_top_row 71*b618a1eeSThomas Cortfunction sets the top row of the menu displayed to be the row given. 72*b618a1eeSThomas CortThe current item becomes the leftmost item of the top row. 73*b618a1eeSThomas CortThe 74*b618a1eeSThomas Cort.Fn top_row 75*b618a1eeSThomas Cortcall returns the row number that is currently at the top of the 76*b618a1eeSThomas Cortdisplayed menu. 77*b618a1eeSThomas Cort.Sh RETURN VALUES 78*b618a1eeSThomas Cort.Fn current_item 79*b618a1eeSThomas Cortreturns NULL if no items are attached to the menu. 80*b618a1eeSThomas Cort.Pp 81*b618a1eeSThomas Cort.Bl -tag -width E_NOT_CONNECTED -compact 82*b618a1eeSThomas Cort.It Er E_OK 83*b618a1eeSThomas CortThe function was successful. 84*b618a1eeSThomas Cort.It Er E_BAD_ARGUMENT 85*b618a1eeSThomas CortOne or more of the arguments passed to the function was incorrect. 86*b618a1eeSThomas Cort.It Er E_BAD_STATE 87*b618a1eeSThomas CortThe function was called from within an initialization or termination 88*b618a1eeSThomas Cortroutine. 89*b618a1eeSThomas Cort.It Er E_NOT_CONNECTED 90*b618a1eeSThomas CortThe item is not connected to a menu. 91*b618a1eeSThomas Cort.El 92*b618a1eeSThomas Cort.Sh SEE ALSO 93*b618a1eeSThomas Cort.Xr curses 3 , 94*b618a1eeSThomas Cort.Xr menus 3 95*b618a1eeSThomas Cort.Sh NOTES 96*b618a1eeSThomas CortThe header 97*b618a1eeSThomas Cort.Pa \*[Lt]menu.h\*[Gt] 98*b618a1eeSThomas Cortautomatically includes both 99*b618a1eeSThomas Cort.Pa \*[Lt]curses.h\*[Gt] 100*b618a1eeSThomas Cortand 101*b618a1eeSThomas Cort.Pa \*[Lt]eti.h\*[Gt] . 102