Seth Woolley's Man Viewer

mitem_current(3X)                                            mitem_current(3X)



NAME
       mitem_current - set(7,n,1 builtins) and get current_menu_item

SYNOPSIS
       #include <menu.h>
       int set_current_item(MENU *menu(3x,n,n tk_menuSetFocus), const ITEM *item);
       ITEM *current_item(const MENU *menu(3x,n,n tk_menuSetFocus));
       int set_top_row(MENU *menu(3x,n,n tk_menuSetFocus), int row);
       int top_row(const MENU *menu(3x,n,n tk_menuSetFocus));
       int item_index(const ITEM *item);

DESCRIPTION
       The  function set_current_item sets the current item (the item on which
       the menu(3x,n,n tk_menuSetFocus) cursor is positioned).  current_item returns a pointer to  the
       current item in(1,8) the given menu.

       The function set_top_row sets the top row of the menu(3x,n,n tk_menuSetFocus) to show the given
       row (the top row is initially 0, and is reset(1,7,1 tput) 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(3x,n,n tk_menuSetFocus) row being displayed.

       The  function item_index returns the (zero-origin) index of item in(1,8) the
       menu(3x,n,n tk_menuSetFocus)'s item pointer list.

RETURN VALUE
       current_item returns NULL on error.

       top_row and item_index return ERR (the general curses error(8,n)  value)  on
       error.

       set_current_item and set_top_row return one of the following:

       E_OK The routine succeeded.

       E_SYSTEM_ERROR
            System error(8,n) occurred (see errno).

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

       E_BAD_STATE
            Routine was called from an initialization or termination function.

       E_NOT_CONNECTED
            No items are connected to the menu.

SEE ALSO
       curses(3X), menu(3x,n,n tk_menuSetFocus)(3X).

NOTES
       The  header  file(1,n)  <menu.h>  automatically  includes  the  header  file(1,n)
       <curses.h>.

PORTABILITY
       These  routines  emulate the System V menu(3x,n,n tk_menuSetFocus) library.  They were not sup-
       ported on Version 7 or BSD versions.

       The  SVr4  menu(3x,n,n tk_menuSetFocus)  library  documentation  specifies  the   top_row   and
       index_item error(8,n) value as -1 (which is the value of ERR).

AUTHORS
       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
       Raymond.



                                                             mitem_current(3X)