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