ncurses 5.3
[ncurses.git] / doc / html / man / mitem_current.3x.html
1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
2 <!-- 
3   * t
4   ****************************************************************************
5   * Copyright (c) 1998 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.9 1998/12/26 19:52:34 tom Exp @
32 -->
33 <HTML>
34 <HEAD>
35 <TITLE>mitem_current 3x</TITLE>
36 <link rev=made href="mailto:bug-ncurses@gnu.org">
37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
38 </HEAD>
39 <BODY>
40 <H1>mitem_current 3x</H1>
41 <HR>
42 <PRE>
43 <!-- Manpage converted by man2html 3.0.1 -->
44
45 </PRE>
46 <H2>NAME</H2><PRE>
47        <STRONG>mitem_current</STRONG> - set and get current_menu_item
48
49
50 </PRE>
51 <H2>SYNOPSIS</H2><PRE>
52        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
53        int set_current_item(MENU *menu, const ITEM *item);
54        ITEM *current_item(const MENU *menu);
55        int set_top_row(MENU *menu, int row);
56        int top_row(const MENU *menu);
57        int item_index(const ITEM *item);
58
59
60 </PRE>
61 <H2>DESCRIPTION</H2><PRE>
62        The  function  <STRONG>set_current_item</STRONG> sets the current item (the
63        item on  which  the  menu  cursor  is  positioned).   <STRONG>cur-</STRONG>
64        <STRONG>rent_item</STRONG>  returns  a  pointer  to the current item in the
65        given menu.
66
67        The function <STRONG>set_top_row</STRONG> sets the top row of the  menu  to
68        show  the  given  row  (the top row is initially 0, and is
69        reset to this value whenever the <STRONG>O_ROWMAJOR</STRONG> option is tog-
70        gled).   The  item  leftmost on the given row becomes cur-
71        rent.  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
75        <EM>item</EM> in the menu's item pointer list.
76
77
78 </PRE>
79 <H2>RETURN VALUE</H2><PRE>
80        <STRONG>current_item</STRONG> returns <STRONG>NULL</STRONG> on error.
81
82        <STRONG>top_row</STRONG> and <STRONG>item_index</STRONG>  return  <STRONG>ERR</STRONG>  (the  general  <STRONG>curses</STRONG>
83        error value) on error.
84
85        <STRONG>set_current_item</STRONG> and <STRONG>set_top_row</STRONG> return one of the follow-
86        ing:
87
88        <STRONG>E_OK</STRONG> The routine succeeded.
89
90        <STRONG>E_SYSTEM_ERROR</STRONG>
91             System error occurred (see <STRONG>errno</STRONG>).
92
93        <STRONG>E_BAD_ARGUMENT</STRONG>
94             Routine detected an incorrect or  out-of-range  argu-
95             ment.
96
97        <STRONG>E_BAD_STATE</STRONG>
98             Routine was called from an initialization or termina-
99             tion function.
100
101        <STRONG>E_NOT_CONNECTED</STRONG>
102             No items are connected to the menu.
103
104
105 </PRE>
106 <H2>SEE ALSO</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>
111 <H2>NOTES</H2><PRE>
112        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
113        file <STRONG>&lt;curses.h&gt;</STRONG>.
114
115
116 </PRE>
117 <H2>PORTABILITY</H2><PRE>
118        These  routines  emulate  the System V menu library.  They
119        were not supported on Version 7 or BSD versions.
120
121        The SVr4 menu library documentation specifies the  <STRONG>top_row</STRONG>
122        and  <STRONG>index_item</STRONG>  error  value as -1 (which is the value of
123        <STRONG>ERR</STRONG>).
124
125
126 </PRE>
127 <H2>AUTHORS</H2><PRE>
128        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
129        curses by Eric S. Raymond.
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
155
156
157
158
159
160
161
162
163
164
165
166
167
168
169 </PRE>
170 <HR>
171 <ADDRESS>
172 Man(1) output converted with
173 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
174 </ADDRESS>
175 </BODY>
176 </HTML>