X-Git-Url: https://ncurses.scripts.mit.edu/?a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmitem_current.3x.html;h=1e438427910beb821ad70c9c6a5a373cdb94d191;hb=16fbf3f4f7d96b6ee6bf9159b22f26e05962aa3d;hp=ab74dffb56f82a9eb3495be6b4ee651abd5341e5;hpb=b1f61d9f3aa244512045a6b02e759825d7049d34;p=ncurses.git diff --git a/doc/html/man/mitem_current.3x.html b/doc/html/man/mitem_current.3x.html index ab74dffb..1e438427 100644 --- a/doc/html/man/mitem_current.3x.html +++ b/doc/html/man/mitem_current.3x.html @@ -1,137 +1,143 @@ + + +
+ + +- - --
- 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). cur- - rent_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 tog- - gled). The item leftmost on the given row becomes cur- - rent. 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 follow- - ing: - - E_OK The routine succeeded. - - E_SYSTEM_ERROR - System error occurred (see errno). - - E_BAD_ARGUMENT - Routine detected an incorrect or out-of-range argu- - ment. - - E_BAD_STATE - Routine was called from an initialization or termina- - tion function. - - 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. - - - - - +mitem_current(3x) mitem_current(3x) +
+ mitem_current - set and get current_menu_item +
+ #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); +
+ 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 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)). +
+ 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. + mitem_current(3x)-