diff options
Diffstat (limited to 'ncurses-5.2/doc/html/man/mitem_current.3x.html')
| -rw-r--r-- | ncurses-5.2/doc/html/man/mitem_current.3x.html | 137 |
1 files changed, 137 insertions, 0 deletions
diff --git a/ncurses-5.2/doc/html/man/mitem_current.3x.html b/ncurses-5.2/doc/html/man/mitem_current.3x.html new file mode 100644 index 0000000..ab74dff --- /dev/null +++ b/ncurses-5.2/doc/html/man/mitem_current.3x.html @@ -0,0 +1,137 @@ +<HTML> +<BODY> +<PRE> +<!-- Manpage converted by man2html 3.0.1 --> + +</PRE> +<H2>NAME</H2><PRE> + <B>mitem_current</B> - set and get current_menu_item + + +</PRE> +<H2>SYNOPSIS</H2><PRE> + <B>#include</B> <B><menu.h></B> + 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); + + +</PRE> +<H2>DESCRIPTION</H2><PRE> + The function <B>set_current_item</B> sets the current item (the + item on which the menu cursor is positioned). <B>cur-</B> + <B>rent_item</B> returns a pointer to the current item in the + given menu. + + The function <B>set_top_row</B> 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 <B>O_ROWMAJOR</B> option is tog- + gled). The item leftmost on the given row becomes cur- + rent. The function <B>top_row</B> returns the number of the top + menu row being displayed. + + The function <B>item_index</B> returns the (zero-origin) index of + <I>item</I> in the menu's item pointer list. + + +</PRE> +<H2>RETURN VALUE</H2><PRE> + <B>current_item</B> returns <B>NULL</B> on error. + + <B>top_row</B> and <B>item_index</B> return <B>ERR</B> (the general <B>curses</B> + error value) on error. + + <B>set_current_item</B> and <B>set_top_row</B> return one of the follow- + ing: + + <B>E_OK</B> The routine succeeded. + + <B>E_SYSTEM_ERROR</B> + System error occurred (see <B>errno</B>). + + <B>E_BAD_ARGUMENT</B> + Routine detected an incorrect or out-of-range argu- + ment. + + <B>E_BAD_STATE</B> + Routine was called from an initialization or termina- + tion function. + + <B>E_NOT_CONNECTED</B> + No items are connected to the menu. + + +</PRE> +<H2>SEE ALSO</H2><PRE> + <B><A HREF="ncurses.3x.html">curses(3x)</A></B>, <B><A HREF="menu.3x.html">menu(3x)</A></B>. + + +</PRE> +<H2>NOTES</H2><PRE> + The header file <B><menu.h></B> automatically includes the header + file <B><curses.h></B>. + + +</PRE> +<H2>PORTABILITY</H2><PRE> + 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 <B>top_row</B> + and <B>index_item</B> error value as -1 (which is the value of + <B>ERR</B>). + + +</PRE> +<H2>AUTHORS</H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new + curses by Eric S. Raymond. + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + + +</PRE> +<HR> +<ADDRESS> +Man(1) output converted with +<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a> +</ADDRESS> +</BODY> +</HTML> |