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