Sun Microsystems, Inc.
spacerspacer
spacer   www.sun.com docs.sun.com | | |  
spacer
black dot
   
A   B   C   D   E   F   G   H   I   J   K   L   M   N   O   P   Q   R   S   T   U   V   W   X   Y   Z
    
 
Curses Library Functionsmenu_item_current(3CURSES)


NAME

 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 TYPEATTRIBUTE VALUE
MT-LevelUnsafe

SEE ALSO

 

curses(3CURSES), menus(3CURSES), attributes(5)

NOTES

 

The header <menu.h> automatically includes the headers <eti.h> and <curses.h>.


SunOS 5.9Go To TopLast Changed 31 Dec 1996

 
      
      
Copyright 2002 Sun Microsystems, Inc. All rights reserved. Use is subject to license terms.