ncurses 6.0 - patch 20160820
[ncurses.git] / doc / html / man / mitem_current.3x.html
1 <!-- 
2   * t
3   ****************************************************************************
4   * Copyright (c) 1998-2006,2010 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.13 2010/12/04 18:40:45 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 http://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
64        item on  which  the  menu  cursor  is  positioned).   <STRONG>cur-</STRONG>
65        <STRONG>rent_item</STRONG>  returns  a  pointer  to the current item in the
66        given menu.
67
68        The function <STRONG>set_top_row</STRONG> sets the top row of the  menu  to
69        show  the  given  row  (the top row is initially 0, and is
70        reset to this value whenever the <STRONG>O_ROWMAJOR</STRONG> option is tog-
71        gled).   The  item  leftmost on the given row becomes cur-
72        rent.  The function <STRONG>top_row</STRONG> returns the number of the  top
73        menu row being displayed.
74
75        The function <STRONG>item_index</STRONG> returns the (zero-origin) index of
76        <EM>item</EM> in the menu's item pointer list.
77
78
79 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
80        <STRONG>current_item</STRONG> returns a pointer (which may  be  <STRONG>NULL</STRONG>).   It
81        does not set errno.
82
83        <STRONG>top_row</STRONG>  and  <STRONG>item_index</STRONG>  return  <STRONG>ERR</STRONG>  (the general <STRONG>curses</STRONG>
84        error value) if their <EM>menu</EM> parameter is <STRONG>NULL</STRONG>.
85
86        <STRONG>set_current_item</STRONG> and <STRONG>set_top_row</STRONG> return one of the follow-
87        ing:
88
89        <STRONG>E_OK</STRONG> The routine succeeded.
90
91        <STRONG>E_BAD_ARGUMENT</STRONG>
92             Routine  detected  an incorrect or out-of-range argu-
93             ment.
94
95        <STRONG>E_BAD_STATE</STRONG>
96             Routine was called from an initialization or termina-
97             tion function.
98
99        <STRONG>E_NOT_CONNECTED</STRONG>
100             No items are connected to the menu.
101
102        <STRONG>E_SYSTEM_ERROR</STRONG>
103             System error occurred (see <STRONG>errno</STRONG>).
104
105
106 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
107        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
108
109
110 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
111        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
112        file <STRONG>&lt;curses.h&gt;</STRONG>.
113
114
115 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
116        These routines emulate the System V  menu  library.   They
117        were not supported on Version 7 or BSD versions.
118
119        The  SVr4 menu library documentation specifies the <STRONG>top_row</STRONG>
120        and <STRONG>index_item</STRONG> error value as -1 (which is  the  value  of
121        <STRONG>ERR</STRONG>).
122
123
124 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
125        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
126        curses by Eric S. Raymond.
127
128
129
130                                                       <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
131 </PRE>
132 <div class="nav">
133 <ul>
134 <li><a href="#h2-NAME">NAME</a></li>
135 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
136 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
137 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
138 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
139 <li><a href="#h2-NOTES">NOTES</a></li>
140 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
141 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
142 </ul>
143 </div>
144 </BODY>
145 </HTML>