'\" t.\"***************************************************************************.\" Copyright (c) 1998 Free Software Foundation, Inc.                        *.\"                                                                          *.\" Permission is hereby granted, free of charge, to any person obtaining a  *.\" copy of this software and associated documentation files (the            *.\" "Software"), to deal in the Software without restriction, including      *.\" without limitation the rights to use, copy, modify, merge, publish,      *.\" distribute, distribute with modifications, sublicense, and/or sell       *.\" copies of the Software, and to permit persons to whom the Software is    *.\" furnished to do so, subject to the following conditions:                 *.\"                                                                          *.\" The above copyright notice and this permission notice shall be included  *.\" in all copies or substantial portions of the Software.                   *.\"                                                                          *.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *.\"                                                                          *.\" Except as contained in this notice, the name(s) of the above copyright   *.\" holders shall not be used in advertising or otherwise to promote the     *.\" sale, use or other dealings in this Software without prior written       *.\" authorization.                                                           *.\"***************************************************************************.\".\" $Id: mitem_current.3x,v 1.9 1998/12/26 19:52:34 tom Exp $.TH mitem_current 3X "".SH NAME\fBmitem_current\fR - set and get current_menu_item.SH SYNOPSIS\fB#include <menu.h>\fR.brint set_current_item(MENU *menu, const ITEM *item);.brITEM *current_item(const MENU *menu);.brint set_top_row(MENU *menu, int row);.brint top_row(const MENU *menu);.brint item_index(const ITEM *item);.br.SH DESCRIPTIONThe function \fBset_current_item\fR sets the current item (the item on whichthe menu cursor is positioned).  \fBcurrent_item\fR returns a pointer to thecurrent item in the given menu.The function \fBset_top_row\fR sets the top row of the menu to show the givenrow (the top row is initially 0, and is reset to this value whenever the\fBO_ROWMAJOR\fR option is toggled).  The item leftmost on the given rowbecomes current.  The function \fBtop_row\fR returns the number of the top menurow being displayed.The function \fBitem_index\fR returns the (zero-origin) index of \fIitem\fR inthe menu's item pointer list..SH RETURN VALUE\fBcurrent_item\fR returns \fBNULL\fR on error.\fBtop_row\fR and \fBitem_index\fR return \fBERR\fR (the general \fBcurses\fRerror value) on error.\fBset_current_item\fR and \fBset_top_row\fR return one of the following:.TP 5\fBE_OK\fRThe routine succeeded..TP 5\fBE_SYSTEM_ERROR\fRSystem error occurred (see \fBerrno\fR)..TP 5\fBE_BAD_ARGUMENT\fRRoutine detected an incorrect or out-of-range argument..TP 5\fBE_BAD_STATE\fRRoutine was called from an initialization or termination function..TP 5\fBE_NOT_CONNECTED\fRNo items are connected to the menu..SH SEE ALSO\fBcurses\fR(3X), \fBmenu\fR(3X)..SH NOTESThe header file \fB<menu.h>\fR automatically includes the header file\fB<curses.h>\fR..SH PORTABILITYThese routines emulate the System V menu library.  They were not supported onVersion 7 or BSD versions.The SVr4 menu library documentation specifies the \fBtop_row\fR and\fBindex_item\fR error value as -1 (which is the value of \fBERR\fR)..SH AUTHORSJuergen Pfeifer.  Manual pages and adaptation for new curses by EricS. Raymond..\"#.\"# The following sets edit modes for GNU EMACS.\"# Local Variables:.\"# mode:nroff.\"# fill-column:79.\"# End: