diff options
| author | Lorry Tar Creator <lorry-tar-importer@lorry> | 2020-02-12 02:21:21 +0000 |
|---|---|---|
| committer | Lorry Tar Creator <lorry-tar-importer@lorry> | 2020-02-12 02:21:21 +0000 |
| commit | ff448436b2b70771d09b8d5ff34a509dcf02f81b (patch) | |
| tree | 2f7abbba7198a4e1c4a23955bc3a539db5a7d999 /doc/html/man/mitem_current.3x.html | |
| parent | f6d73a10a980bc78969c3af93665cbe7d06c3646 (diff) | |
| download | ncurses-ff448436b2b70771d09b8d5ff34a509dcf02f81b.tar.gz | |
ncurses-6.2ncurses-6.2
Diffstat (limited to 'doc/html/man/mitem_current.3x.html')
| -rw-r--r-- | doc/html/man/mitem_current.3x.html | 117 |
1 files changed, 57 insertions, 60 deletions
diff --git a/doc/html/man/mitem_current.3x.html b/doc/html/man/mitem_current.3x.html index d82a270..77f2616 100644 --- a/doc/html/man/mitem_current.3x.html +++ b/doc/html/man/mitem_current.3x.html @@ -1,8 +1,8 @@ -<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <!-- * t **************************************************************************** - * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * + * Copyright 2018-2019,2020 Thomas E. Dickey * + * Copyright 1998-2006,2010 Free Software Foundation, Inc. * * * * Permission is hereby granted, free of charge, to any person obtaining a * * copy of this software and associated documentation files (the * @@ -28,116 +28,113 @@ * sale, use or other dealings in this Software without prior written * * authorization. * **************************************************************************** - * @Id: mitem_current.3x,v 1.13 2010/12/04 18:40:45 tom Exp @ + * @Id: mitem_current.3x,v 1.17 2020/02/02 23:34:34 tom Exp @ --> +<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN"> <HTML> <HEAD> +<meta http-equiv="Content-Type" content="text/html; charset=us-ascii"> +<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts"> <TITLE>mitem_current 3x</TITLE> -<link rev=made href="mailto:bug-ncurses@gnu.org"> +<link rel="author" href="mailto:bug-ncurses@gnu.org"> <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1"> </HEAD> <BODY> -<H1>mitem_current 3x</H1> -<HR> +<H1 class="no-header">mitem_current 3x</H1> <PRE> -<!-- Manpage converted by man2html 3.0.1 --> -<STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> +<STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> -</PRE> -<H2>NAME</H2><PRE> +</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE> <STRONG>mitem_current</STRONG> - set and get current_menu_item -</PRE> -<H2>SYNOPSIS</H2><PRE> +</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE> <STRONG>#include</STRONG> <STRONG><menu.h></STRONG> - 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); int item_index(const ITEM *item); -</PRE> -<H2>DESCRIPTION</H2><PRE> - The function <STRONG>set_current_item</STRONG> sets the current item (the - item on which the menu cursor is positioned). <STRONG>cur-</STRONG> - <STRONG>rent_item</STRONG> returns a pointer to the current item in the - given menu. - - The function <STRONG>set_top_row</STRONG> 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 <STRONG>O_ROWMAJOR</STRONG> option is tog- - gled). The item leftmost on the given row becomes cur- - rent. The function <STRONG>top_row</STRONG> returns the number of the top +</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE> + The function <STRONG>set_current_item</STRONG> sets the current item (the item on which + the menu cursor is positioned). <STRONG>current_item</STRONG> returns a pointer to the + current item in the given menu. + + The function <STRONG>set_top_row</STRONG> 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 <STRONG>O_ROWMAJOR</STRONG> option is toggled). The item leftmost on the given row + becomes current. The function <STRONG>top_row</STRONG> returns the number of the top menu row being displayed. - The function <STRONG>item_index</STRONG> returns the (zero-origin) index of - <EM>item</EM> in the menu's item pointer list. + The function <STRONG>item_index</STRONG> returns the (zero-origin) index of <EM>item</EM> in the + menu's item pointer list. -</PRE> -<H2>RETURN VALUE</H2><PRE> - <STRONG>current_item</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It - does not set errno. +</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE> + <STRONG>current_item</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It does not set + errno. - <STRONG>top_row</STRONG> and <STRONG>item_index</STRONG> return <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG> - error value) if their <EM>menu</EM> parameter is <STRONG>NULL</STRONG>. + <STRONG>top_row</STRONG> and <STRONG>item_index</STRONG> return <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG> error value) if + their <EM>menu</EM> parameter is <STRONG>NULL</STRONG>. - <STRONG>set_current_item</STRONG> and <STRONG>set_top_row</STRONG> return one of the follow- - ing: + <STRONG>set_current_item</STRONG> and <STRONG>set_top_row</STRONG> return one of the following: <STRONG>E_OK</STRONG> The routine succeeded. <STRONG>E_BAD_ARGUMENT</STRONG> - Routine detected an incorrect or out-of-range argu- - ment. + Routine detected an incorrect or out-of-range argument. <STRONG>E_BAD_STATE</STRONG> - Routine was called from an initialization or termina- - tion function. + Routine was called from an initialization or termination function. <STRONG>E_NOT_CONNECTED</STRONG> No items are connected to the menu. <STRONG>E_SYSTEM_ERROR</STRONG> - System error occurred (see <STRONG>errno</STRONG>). + System error occurred (see <STRONG>errno(3)</STRONG>). -</PRE> -<H2>SEE ALSO</H2><PRE> +</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE> <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>. -</PRE> -<H2>NOTES</H2><PRE> - The header file <STRONG><menu.h></STRONG> automatically includes the header - file <STRONG><curses.h></STRONG>. +</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE> + The header file <STRONG><menu.h></STRONG> automatically includes the header file + <STRONG><curses.h></STRONG>. -</PRE> -<H2>PORTABILITY</H2><PRE> - These routines emulate the System V menu library. They - were not supported on Version 7 or BSD versions. +</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE> + 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 <STRONG>top_row</STRONG> - and <STRONG>index_item</STRONG> error value as -1 (which is the value of - <STRONG>ERR</STRONG>). + The SVr4 menu library documentation specifies the <STRONG>top_row</STRONG> and + <STRONG>index_item</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>). -</PRE> -<H2>AUTHORS</H2><PRE> - Juergen Pfeifer. Manual pages and adaptation for new - curses by Eric S. Raymond. +</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE> + Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. + Raymond. - <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> + <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG> </PRE> -<HR> -Man(1) output converted with <a href="http://invisible-island.net/scripts/readme.html#others_scripts">man2html</a> +<div class="nav"> +<ul> +<li><a href="#h2-NAME">NAME</a></li> +<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li> +<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li> +<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li> +<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li> +<li><a href="#h2-NOTES">NOTES</a></li> +<li><a href="#h2-PORTABILITY">PORTABILITY</a></li> +<li><a href="#h2-AUTHORS">AUTHORS</a></li> +</ul> +</div> </BODY> </HTML> |