man/man3curses/menu_item_current.3curses

         te
 Copyright 1989 AT&T
 Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
 The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
 You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
 When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
 MENU_ITEM_CURRENT 3CURSES "Dec 31, 1996"
 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 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>.