mitem_current3menu
Set and get current_menu_item
Part of menu_current(3menu).
Usage
#include <menu.h>
int set_current_item(MENU *menu, ITEM *item); ITEM *current_item(const MENU *menu);
int set_top_row(MENU *menu, int row); int top_row(const MENU *menu);
int item_index(const ITEM *item);
Overview
The function set_current_item sets the current item (the item on which the menu cursor is positioned). current_item returns a pointer to the current item in the given menu.
The function set_top_row sets the top row of the menu to show the given row (the top row is initially 0, and is reset to this value whenever the O_ROWMAJOR option is toggled). The item leftmost on the given row becomes current. The function top_row returns the number of the top menu row being displayed.
The function item_index returns the (zero-origin) index of item in the menu's item pointer list.
Return value
current_item returns a pointer (which may be NULL). It does not set errno.
top_row and item_index return ERR (the general curses error value) if their menu parameter is NULL.
set_current_item and set_top_row return one of the following:
|
The routine succeeded. |
|---|---|
|
Routine detected an incorrect or out-of-range argument. |
|
Routine was called from an initialization or termination function. |
|
No items are connected to the menu. |
|
System error occurred (see errno(3)). |
Portability
These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions.
The SVr4 menu library documentation specifies the top_row and index_item error value as -1 (which is the value of ERR).
Releases
12 releases since Debian 3.0 (Woody); the text changed 8 times.