'\" te
.\" Copyright 1989 AT&T
.\" Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
.TH menu_item_current 3CURSES "31 Dec 1996" "SunOS 5.11" "Curses Library Functions"
.SH NAME
menu_item_current, set_current_item, current_item, set_top_row, top_row, item_index \- set and get current menus items
.SH SYNOPSIS
.LP
.nf
\fBcc\fR [ \fIflag\fR... ] \fIfile\fR... \fB-lmenu\fR \fB -lcurses \fR [ \fIlibrary\fR... ]
#include <menu.h>

\fBint\fR \fBset_current_item\fR(\fBMENU *\fR\fImenu\fR, \fBITEM *\fR\fIitem\fR);
.fi

.LP
.nf
\fBITEM *\fR\fBcurrent_item\fR(\fBMENU *\fR\fImenu\fR);
.fi

.LP
.nf
\fBint\fR \fBset_top_row\fR(\fBMENU *\fR\fImenu\fR, \fBint\fR \fIrow\fR);
.fi

.LP
.nf
\fBint\fR \fBtop_row\fR(\fBMENU *\fR\fImenu\fR);
.fi

.LP
.nf
\fBint\fR \fBitem_index\fR(\fBITEM *\fR\fIitem\fR);
.fi

.SH DESCRIPTION
.sp
.LP
The current item of a menu is the item where the cursor is currently positioned. \fBset_current_item()\fR sets the current item of \fImenu\fR to \fIitem\fR. \fBcurrent_item()\fR returns a pointer to the the current item in \fImenu\fR.
.sp
.LP
\fBset_top_row()\fR sets the top row of \fImenu\fR to \fIrow\fR. The left-most item on the new top row becomes the current item. \fBtop_row()\fR returns the number  of the menu row currently displayed at the top of \fImenu\fR.
.sp
.LP
\fBitem_index()\fR returns the index to the \fIitem\fR in the item pointer array. The value of this index ranges from \fB0\fR through \fIN\fR\fB-1\fR, where \fIN\fR is the total number of items connected to the menu.
.SH RETURN VALUES
.sp
.LP
\fBcurrent_item()\fR returns \fBNULL\fR on error.
.sp
.LP
\fBtop_row()\fR and \fBindex_item()\fR return \fB\(mi1\fR on error.
.sp
.LP
\fBset_current_item()\fR and \fBset_top_row()\fR return one of the following: 
.sp
.ne 2
.mk
.na
\fBE_OK\fR
.ad
.RS 19n
.rt  
The routine returned successfully.
.RE

.sp
.ne 2
.mk
.na
\fBE_SYSTEM_ERROR\fR
.ad
.RS 19n
.rt  
System error.
.RE

.sp
.ne 2
.mk
.na
\fBE_BAD_ARGUMENT\fR
.ad
.RS 19n
.rt  
An incorrect argument was passed to the routine.
.RE

.sp
.ne 2
.mk
.na
\fBE_BAD_STATE\fR
.ad
.RS 19n
.rt  
The routine was called from an	initialization or termination function. 
.RE

.sp
.ne 2
.mk
.na
\fBE_NOT_CONNECTED\fR
.ad
.RS 19n
.rt  
No items are connected to the menu.
.RE

.SH ATTRIBUTES
.sp
.LP
See \fBattributes\fR(5) for descriptions of the following attributes:
.sp

.sp
.TS
tab() box;
cw(2.75i) |cw(2.75i) 
lw(2.75i) |lw(2.75i) 
.
ATTRIBUTE TYPEATTRIBUTE VALUE
_
MT-LevelUnsafe
.TE

.SH SEE ALSO
.sp
.LP
\fBcurses\fR(3CURSES), \fBmenus\fR(3CURSES), \fBattributes\fR(5)
.SH NOTES
.sp
.LP
The header \fB<menu.h>\fR automatically includes the headers  \fB<eti.h>\fR and \fB<curses.h>\fR\&.