xref: /freebsd/contrib/ncurses/menu/m_item_vis.c (revision 9336e0699bda8a301cd2bfa37106b6ec5e32012e)
1 /****************************************************************************
2  * Copyright (c) 1998-2003,2004 Free Software Foundation, Inc.              *
3  *                                                                          *
4  * Permission is hereby granted, free of charge, to any person obtaining a  *
5  * copy of this software and associated documentation files (the            *
6  * "Software"), to deal in the Software without restriction, including      *
7  * without limitation the rights to use, copy, modify, merge, publish,      *
8  * distribute, distribute with modifications, sublicense, and/or sell       *
9  * copies of the Software, and to permit persons to whom the Software is    *
10  * furnished to do so, subject to the following conditions:                 *
11  *                                                                          *
12  * The above copyright notice and this permission notice shall be included  *
13  * in all copies or substantial portions of the Software.                   *
14  *                                                                          *
15  * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
16  * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
17  * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
18  * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
19  * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
20  * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
21  * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
22  *                                                                          *
23  * Except as contained in this notice, the name(s) of the above copyright   *
24  * holders shall not be used in advertising or otherwise to promote the     *
25  * sale, use or other dealings in this Software without prior written       *
26  * authorization.                                                           *
27  ****************************************************************************/
28 
29 /****************************************************************************
30  *   Author:  Juergen Pfeifer, 1995,1997                                    *
31  ****************************************************************************/
32 
33 /***************************************************************************
34 * Module m_item_vis                                                        *
35 * Tell if menu item is visible                                             *
36 ***************************************************************************/
37 
38 #include "menu.priv.h"
39 
40 MODULE_ID("$Id: m_item_vis.c,v 1.15 2004/12/25 21:40:09 tom Exp $")
41 
42 /*---------------------------------------------------------------------------
43 |   Facility      :  libnmenu
44 |   Function      :  bool item_visible(const ITEM *item)
45 |
46 |   Description   :  A item is visible if it currently appears in the
47 |                    subwindow of a posted menu.
48 |
49 |   Return Values :  TRUE  if visible
50 |                    FALSE if invisible
51 +--------------------------------------------------------------------------*/
52 NCURSES_EXPORT(bool)
53 item_visible(const ITEM * item)
54 {
55   MENU *menu;
56 
57   T((T_CALLED("item_visible(%p)"), item));
58   if (item &&
59       (menu = item->imenu) &&
60       (menu->status & _POSTED) &&
61       ((menu->toprow + menu->arows) > (item->y)) &&
62       (item->y >= menu->toprow))
63     returnBool(TRUE);
64   else
65     returnBool(FALSE);
66 }
67 
68 /* m_item_vis.c ends here */
69