mitem_current()

NAME

set_current_item(), current_item(), set_top_row(), top_row(), item_index() - set and get current_menu_item

SYNOPSIS

#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 function set_current_item(3) sets the current item (the item on which the menu cursor is positioned). current_item(3) returns a pointer to the current item in the given menu.

The function set_top_row(3) 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(3) returns the number of the top menu row being displayed.

The function item_index(3) returns the (zero-origin) index of item in the menu's item pointer list.

RETURN VALUE

current_item(3) returns NULL on error.

top_row(3) and item_index(3) return ERR (the general curses error value) on error.

set_current_item(3) and set_top_row(3) return one of the following:

E_OK

The routine succeeded.

E_SYSTEM_ERROR

System error occurred (see errno

E_BAD_ARGUMENT

Routine detected an incorrect or out-of-range argument.

E_BAD_STATE

Routine was called from an initialization or termination function.

E_NOT_CONNECTED

No items are connected to the menu.

SEE ALSO

curses(3)

menus(3)

NOTES

The header file <menu.h> automatically includes the header file <curses.h>.

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(3) and item_index(3) error value as -1 (which is the value of ERR).