X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=doc%2Fhtml%2Fman%2Fmitem_current.3x.html;h=77f2616838578b63cce1b91ca20ee5a983a9c48e;hp=66c68a5c9023ab601c562d8beec0d542ff6b817d;hb=a90dd7b66fa711acd24d8181ea20e4f57d4b36cd;hpb=6208c89f98f1cf9fe0980bd8e791846ce007a13d diff --git a/doc/html/man/mitem_current.3x.html b/doc/html/man/mitem_current.3x.html index 66c68a5c..77f26168 100644 --- a/doc/html/man/mitem_current.3x.html +++ b/doc/html/man/mitem_current.3x.html @@ -1,7 +1,8 @@
- +-mitem_current(3x) mitem_current(3x) +mitem_current(3x) mitem_current(3x) @@ -52,7 +53,7 @@
#include <menu.h> - int set_current_item(MENU *menu, const ITEM *item); + 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); @@ -60,47 +61,42 @@
- 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 + 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. + 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. + 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. + 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 follow- - ing: + 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 argu- - ment. + Routine detected an incorrect or out-of-range argument. E_BAD_STATE - Routine was called from an initialization or termina- - tion function. + 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). + System error occurred (see errno(3)).
@@ -108,26 +104,25 @@
- The header file <menu.h> automatically includes the header - file <curses.h>. + 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. + These routines emulate the System V menu library. They were not sup- + ported 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). + 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. + Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. - mitem_current(3x) + mitem_current(3x)