ncurses 6.2 - patch 20200425
[ncurses.git] / doc / html / man / mitem_current.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2006,2010 Free Software Foundation, Inc.                  *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: mitem_current.3x,v 1.18 2020/03/28 19:06:28 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>mitem_current 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">mitem_current 3x</H1>
44 <PRE>
45 <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>                                            <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>mitem_current</STRONG> - set and get current_menu_item
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
56        int set_current_item(MENU *menu, ITEM *item);
57        ITEM *current_item(const MENU *menu);
58        int set_top_row(MENU *menu, int row);
59        int top_row(const MENU *menu);
60        int item_index(const ITEM *item);
61
62
63 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
64        The  function <STRONG>set_current_item</STRONG> sets the current item (the item on which
65        the menu cursor is positioned).  <STRONG>current_item</STRONG> returns a pointer to  the
66        current item in the given menu.
67
68        The function <STRONG>set_top_row</STRONG> sets the top row of the menu to show the given
69        row (the top row is initially 0, and is reset to  this  value  whenever
70        the  <STRONG>O_ROWMAJOR</STRONG> option is toggled).  The item leftmost on the given row
71        becomes current.  The function <STRONG>top_row</STRONG> returns the number  of  the  top
72        menu row being displayed.
73
74        The  function <STRONG>item_index</STRONG> returns the (zero-origin) index of <EM>item</EM> in the
75        menu's item pointer list.
76
77
78 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
79        <STRONG>current_item</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>).  It  does  not  set
80        <STRONG>errno</STRONG>.
81
82        <STRONG>top_row</STRONG>  and  <STRONG>item_index</STRONG> return <STRONG>ERR</STRONG> (the general <STRONG>curses</STRONG> error value) if
83        their <EM>menu</EM> parameter is <STRONG>NULL</STRONG>.
84
85        <STRONG>set_current_item</STRONG> and <STRONG>set_top_row</STRONG> return one of the following:
86
87        <STRONG>E_OK</STRONG> The routine succeeded.
88
89        <STRONG>E_BAD_ARGUMENT</STRONG>
90             Routine detected an incorrect or out-of-range argument.
91
92        <STRONG>E_BAD_STATE</STRONG>
93             Routine was called from an initialization or termination function.
94
95        <STRONG>E_NOT_CONNECTED</STRONG>
96             No items are connected to the menu.
97
98        <STRONG>E_SYSTEM_ERROR</STRONG>
99             System error occurred (see <STRONG>errno(3)</STRONG>).
100
101
102 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
103        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
104
105
106 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
107        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
108        <STRONG>&lt;curses.h&gt;</STRONG>.
109
110
111 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
112        These  routines  emulate the System V menu library.  They were not sup-
113        ported on Version 7 or BSD versions.
114
115        The  SVr4  menu  library  documentation  specifies  the   <STRONG>top_row</STRONG>   and
116        <STRONG>index_item</STRONG> error value as -1 (which is the value of <STRONG>ERR</STRONG>).
117
118
119 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
120        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
121        Raymond.
122
123
124
125                                                              <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
126 </PRE>
127 <div class="nav">
128 <ul>
129 <li><a href="#h2-NAME">NAME</a></li>
130 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
131 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
132 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
133 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
134 <li><a href="#h2-NOTES">NOTES</a></li>
135 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
136 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
137 </ul>
138 </div>
139 </BODY>
140 </HTML>