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