man7.org > Linux > man-pages

Linux/UNIX system programming training

mitem_current(3x) — Linux manual page

NAME | SYNOPSIS | DESCRIPTION | RETURN VALUE | SEE ALSO | NOTES | PORTABILITY | AUTHORS | COLOPHON 

mitem_current(3X)                                      mitem_current(3X)

NAME         top

       mitem_current - set and get current_menu_item

SYNOPSIS         top

       #include <menu.h>

       int set_current_item(MENU *menu, 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);

DESCRIPTION         top

       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.

RETURN VALUE         top

       current_item returns a pointer (which may be NULL).  It does not
       set errno.

       top_row and item_index return ERR (the general curses error
       value) if their menu parameter is NULL.

       set_current_item and set_top_row return one of the following:

       E_OK The routine succeeded.

       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.

       E_SYSTEM_ERROR
            System error occurred (see errno(3)).

SEE ALSO         top

       curses(3X), menu(3X).

NOTES         top

       The header file <menu.h> automatically includes the header file
       <curses.h>.

PORTABILITY         top

       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).

AUTHORS         top

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

COLOPHON         top

       This page is part of the ncurses (new curses) project.
       Information about the project can be found at 
       ⟨https://www.gnu.org/software/ncurses/ncurses.html⟩.  If you have
       a bug report for this manual page, send it to
       bug-ncurses-request@gnu.org.  This page was obtained from the
       project's upstream Git mirror of the CVS repository
       ⟨https://github.com/mirror/ncurses.git⟩ on 2024-06-14.  (At that
       time, the date of the most recent commit that was found in the
       repository was 2023-03-12.)  If you discover any rendering
       problems in this HTML version of the page, or you believe there
       is a better or more up-to-date source for the page, or you have
       corrections or improvements to the information in this COLOPHON
       (which is not part of the original manual page), send a mail to
       man-pages@man7.org

                                                       mitem_current(3X)

HTML rendering created 2024-06-26 by Michael Kerrisk, author of The Linux Programming Interface.

For details of in-depth Linux/UNIX system programming training courses that I teach, look here.

Hosting by jambit GmbH.

Cover of TLPI