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 $
mitem_current - set and get current_menu_item #include <menu.h>

int set_current_item(MENU *menu, const ITEM *item);

ITEM *current_item(const MENU *menu);

int set_top_row(MENU *menu, int row);

int top_row(const MENU *menu);

int item_index(const ITEM *item);

The function set_current_item sets the current item (the item on which the menu cursor is positioned). current_item returns a pointer to the current item in the given menu. The function set_top_row 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 returns the number of the top menu row being displayed. The function item_index returns the (zero-origin) index of item in the menu's item pointer list. current_item returns NULL on error. top_row and item_index return ERR (the general curses error value) on error. set_current_item and set_top_row return one of the following:

5 E_OK The routine succeeded.

5 E_SYSTEM_ERROR System error occurred (see errno).

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

5 E_BAD_STATE Routine was called from an initialization or termination function.

5 E_NOT_CONNECTED No items are connected to the menu.

curses(3X), menu(3X). The header file <menu.h> automatically includes the header file <curses.h>. 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 and index_item error value as -1 (which is the value of ERR). Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond. #
# The following sets edit modes for GNU EMACS
# Local Variables:
# mode:nroff
# fill-column:79
# End: