ncurses 6.1 - patch 20190615
[ncurses.git] / man / mitem_visible.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2010,2018 Free Software Foundation, Inc.              *
4 .\"                                                                          *
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 .\" $Id: mitem_visible.3x,v 1.8 2018/07/28 21:34:06 tom Exp $
31 .TH mitem_visible 3X ""
32 .SH NAME
33 \fBmitem_visible\fR \- check visibility of a menu item
34 .SH SYNOPSIS
35 \fB#include <menu.h>\fR
36 .br
37 bool item_visible(const ITEM *item);
38 .br
39 .SH DESCRIPTION
40 A menu item is visible when it is in the portion of a posted menu that
41 is mapped onto the screen (if the menu is scrollable, in particular, this
42 portion will be smaller than the whole menu).
43 .SH SEE ALSO
44 \fBcurses\fR(3X), \fBmenu\fR(3X).
45 .SH NOTES
46 The header file \fB<menu.h>\fR automatically includes the header file
47 \fB<curses.h>\fR.
48 .SH PORTABILITY
49 These routines emulate the System V menu library.
50 They were not supported on
51 Version 7 or BSD versions.
52 .SH AUTHORS
53 Juergen Pfeifer.
54 Manual pages and adaptation for new curses by Eric S. Raymond.