menu_items.3 revision 1.1
Copyright (c) 1999
Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
This code is donated to The NetBSD Foundation by the author.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the Author may not be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$Id: menu_items.3,v 1.1 1999/11/23 11:12:36 blymn Exp $
.Dd September, 1999 .Dt MENU_ITEMS 3 .Os BSD 4 .Sh NAME .Nm item_count , .Nm menu_items , .Nm set_menu_items .Nd menu library .Sh LIBRARY .Lb libmenu .Sh SYNOPSIS .Fd #include <menu.h> .Ft int .Fn item_count "MENU *menu" .Ft ITEMS ** .Fn menu_items "MENU *menu" .Ft int .Fn set_menu_items "MENU *menu" "ITEM **items" .Sh DESCRIPTION The .Fn item_count .Fa menu function returns the number of items currently attached to the menu passed. The .Fn menu_items function returns a pointer to an array of item pointers that represent the menu items currently attached to the given menu. Apart from using .Xr new_menu menu items may be attached to a menu by calling .Fn set_menu_items any items currently attached to the menu will be detached and the NULL terminated array of new items will be attached to the menu. .Sh RETURN VALUES Any function returning a string pointer will return NULL if an error occurs. Functions returning an integer will return one of the following:
Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
This code is donated to The NetBSD Foundation by the author.
Redistribution and use in source and binary forms, with or without
modification, are permitted provided that the following conditions
are met:
1. Redistributions of source code must retain the above copyright
notice, this list of conditions and the following disclaimer.
2. Redistributions in binary form must reproduce the above copyright
notice, this list of conditions and the following disclaimer in the
documentation and/or other materials provided with the distribution.
3. The name of the Author may not be used to endorse or promote
products derived from this software without specific prior written
permission.
THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
SUCH DAMAGE.
$Id: menu_items.3,v 1.1 1999/11/23 11:12:36 blymn Exp $
.Dd September, 1999 .Dt MENU_ITEMS 3 .Os BSD 4 .Sh NAME .Nm item_count , .Nm menu_items , .Nm set_menu_items .Nd menu library .Sh LIBRARY .Lb libmenu .Sh SYNOPSIS .Fd #include <menu.h> .Ft int .Fn item_count "MENU *menu" .Ft ITEMS ** .Fn menu_items "MENU *menu" .Ft int .Fn set_menu_items "MENU *menu" "ITEM **items" .Sh DESCRIPTION The .Fn item_count .Fa menu function returns the number of items currently attached to the menu passed. The .Fn menu_items function returns a pointer to an array of item pointers that represent the menu items currently attached to the given menu. Apart from using .Xr new_menu menu items may be attached to a menu by calling .Fn set_menu_items any items currently attached to the menu will be detached and the NULL terminated array of new items will be attached to the menu. .Sh RETURN VALUES Any function returning a string pointer will return NULL if an error occurs. Functions returning an integer will return one of the following:
p
E_OK The function was successful E_POSTED The menu is already posted. E_CONNECTED An item was already connected to a menu.
.Sh SEE ALSO .Xr curses 3 , .Xr menus 3 .Sh NOTES The header .Xr <menus.h> automatically includes both .Xr <curses.h> and .Xr <eti.h>