+<!--
+ * t
+ ****************************************************************************
+ * 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 *
+ * "Software"), to deal in the Software without restriction, including *
+ * without limitation the rights to use, copy, modify, merge, publish, *
+ * distribute, distribute with modifications, sublicense, and/or sell *
+ * copies of the Software, and to permit persons to whom the Software is *
+ * furnished to do so, subject to the following conditions: *
+ * *
+ * The above copyright notice and this permission notice shall be included *
+ * in all copies or substantial portions of the Software. *
+ * *
+ * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
+ * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
+ * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
+ * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
+ * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
+ * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
+ * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
+ * *
+ * Except as contained in this notice, the name(s) of the above copyright *
+ * holders shall not be used in advertising or otherwise to promote the *
+ * sale, use or other dealings in this Software without prior written *
+ * authorization. *
+ ****************************************************************************
+ * @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 rel="author" href="mailto:bug-ncurses@gnu.org">
+<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
+</HEAD>
<BODY>
+<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>
-</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);
+
+</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
+ <STRONG>mitem_current</STRONG> - set and get current_menu_item
+
+
+</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
+ <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
+ 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 <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.
+</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 <B>item_index</B> returns the (zero-origin) index of
- <I>item</I> in the menu's item pointer list.
+ 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.
-</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.
+</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.
- <B>set_current_item</B> and <B>set_top_row</B> return one of the follow-
- ing:
+ <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>.
- <B>E_OK</B> The routine succeeded.
+ <STRONG>set_current_item</STRONG> and <STRONG>set_top_row</STRONG> return one of the following:
- <B>E_SYSTEM_ERROR</B>
- System error occurred (see <B>errno</B>).
+ <STRONG>E_OK</STRONG> The routine succeeded.
- <B>E_BAD_ARGUMENT</B>
- Routine detected an incorrect or out-of-range argu-
- ment.
+ <STRONG>E_BAD_ARGUMENT</STRONG>
+ Routine detected an incorrect or out-of-range argument.
- <B>E_BAD_STATE</B>
- Routine was called from an initialization or termina-
- tion function.
+ <STRONG>E_BAD_STATE</STRONG>
+ Routine was called from an initialization or termination function.
- <B>E_NOT_CONNECTED</B>
+ <STRONG>E_NOT_CONNECTED</STRONG>
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.
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
-
+ <STRONG>E_SYSTEM_ERROR</STRONG>
+ System error occurred (see <STRONG>errno(3)</STRONG>).
+</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><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><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>).
+</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>
</PRE>
-<HR>
-<ADDRESS>
-Man(1) output converted with
-<a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
-</ADDRESS>
+<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>
projects / ncurses.git / blobdiff