xref: /freebsd/contrib/ncurses/menu/m_item_nam.c (revision f4b37ed0f8b307b1f3f0f630ca725d68f1dff30d)
1 /****************************************************************************
2  * Copyright (c) 1998-2004,2010 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_nam                                                        *
35 * Get menus item name and description                                      *
36 ***************************************************************************/
37 
38 #include "menu.priv.h"
39 
40 MODULE_ID("$Id: m_item_nam.c,v 1.15 2010/01/23 21:20:10 tom Exp $")
41 
42 /*---------------------------------------------------------------------------
43 |   Facility      :  libnmenu
44 |   Function      :  char *item_name(const ITEM *item)
45 |
46 |   Description   :  Return name of menu item
47 |
48 |   Return Values :  See above; returns NULL if item is invalid
49 +--------------------------------------------------------------------------*/
50 NCURSES_EXPORT(const char *)
51 item_name(const ITEM * item)
52 {
53   T((T_CALLED("item_name(%p)"), (const void *)item));
54   returnCPtr((item) ? item->name.str : (char *)0);
55 }
56 
57 /*---------------------------------------------------------------------------
58 |   Facility      :  libnmenu
59 |   Function      :  char *item_description(const ITEM *item)
60 |
61 |   Description   :  Returns description of item
62 |
63 |   Return Values :  See above; Returns NULL if item is invalid
64 +--------------------------------------------------------------------------*/
65 NCURSES_EXPORT(const char *)
66 item_description(const ITEM * item)
67 {
68   T((T_CALLED("item_description(%p)"), (const void *)item));
69   returnCPtr((item) ? item->description.str : (char *)0);
70 }
71 
72 /* m_item_nam.c ends here */
73