Linux and UNIX Man Pages

Linux & Unix Commands - Search Man Pages

menu_item_current(3) [netbsd man page]

MENU_ITEM_CURRENT(3)					   BSD Library Functions Manual 				      MENU_ITEM_CURRENT(3)

current_item, item_index, set_current_item, set_top_row top_row -- get or set item pointers or top row LIBRARY
Curses Menu Library (libmenu, -lmenu) SYNOPSIS
#include <menu.h> ITEM * current_item(MENU *menu); int item_index(ITEM *item); int set_current_item(MENU *menu, ITEM *item); int set_top_row(MENU *menu, int row); int top_row(MENU *menu); DESCRIPTION
The current_item() returns a pointer to the current menu item. The set_current_item() can be used to set this to the item give. The item_index() function returns the index number in the array of items for the item pointed to by the item parameter. The set_top_row() func- tion sets the top row of the menu displayed to be the row given. The current item becomes the leftmost item of the top row. The top_row() call returns the row number that is currently at the top of the displayed menu. RETURN VALUES
current_item() returns NULL if no items are attached to the menu. E_OK The function was successful. E_BAD_ARGUMENT One or more of the arguments passed to the function was incorrect. E_BAD_STATE The function was called from within an initialization or termination routine. E_NOT_CONNECTED The item is not connected to a menu. SEE ALSO
curses(3), menus(3) NOTES
The header <menu.h> automatically includes both <curses.h> and <eti.h>. BSD
September 10, 1999 BSD

Check Out this Related Man Page

menu_item_current(3CURSES)				     Curses Library Functions					menu_item_current(3CURSES)

menu_item_current, set_current_item, current_item, set_top_row, top_row, item_index - set and get current menus items SYNOPSIS
cc [ flag... ] file... -lmenu -lcurses [ library... ] #include <menu.h> int set_current_item(MENU *menu, ITEM *item); ITEM *current_item(MENU *menu); int set_top_row(MENU *menu, int row); int top_row(MENU *menu); int item_index(ITEM *item); DESCRIPTION
The current item of a menu is the item where the cursor is currently positioned. set_current_item() sets the current item of menu to item. current_item() returns a pointer to the the current item in menu. set_top_row() sets the top row of menu to row. The left-most item on the new top row becomes the current item. top_row() returns the number of the menu row currently displayed at the top of menu. item_index() returns the index to the item in the item pointer array. The value of this index ranges from 0 through N-1, where N is the total number of items connected to the menu. RETURN VALUES
current_item() returns NULL on error. top_row() and index_item() return -1 on error. set_current_item() and set_top_row() return one of the following: E_OK The routine returned successfully. E_SYSTEM_ERROR System error. E_BAD_ARGUMENT An incorrect argument was passed to the routine. E_BAD_STATE The routine was called from an initialization or termination function. E_NOT_CONNECTED No items are connected to the menu. ATTRIBUTES
See attributes(5) for descriptions of the following attributes: +-----------------------------+-----------------------------+ | ATTRIBUTE TYPE | ATTRIBUTE VALUE | +-----------------------------+-----------------------------+ |MT-Level |Unsafe | +-----------------------------+-----------------------------+ SEE ALSO
curses(3CURSES), menus(3CURSES), attributes(5) NOTES
The header <menu.h> automatically includes the headers <eti.h> and <curses.h>. SunOS 5.11 31 Dec 1996 menu_item_current(3CURSES)
Man Page