1.\" $NetBSD: menu_item_visible.3,v 1.7 2003/04/16 13:35:11 wiz 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_VISIBLE 3 34.Os 35.Sh NAME 36.Nm item_visible 37.Nd get visibility status of an item 38.Sh LIBRARY 39.Lb libmenu 40.Sh SYNOPSIS 41.In menu.h 42.Ft int 43.Fn item_visible "ITEM *item" 44.Sh DESCRIPTION 45The 46.Fn item_visible 47function returns TRUE if the item passed is currently visible in a 48menu. 49.Sh RETURN VALUES 50The functions return one of the following error values: 51.Pp 52.Bl -tag -width E_NOT_CONNECTED -compact 53.It Er E_BAD_ARGUMENT 54One or more of the arguments passed to the function was incorrect. 55.It Er E_NOT_CONNECTED 56The item is not connected to a menu. 57.El 58.Sh SEE ALSO 59.Xr curses 3 , 60.Xr menus 3 61.Sh NOTES 62The header 63.Pa \*[Lt]menu.h\*[Gt] 64automatically includes both 65.Pa \*[Lt]curses.h\*[Gt] 66and 67.Pa \*[Lt]eti.h\*[Gt] . 68