ncurses 5.7 - patch 20100731
[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-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.12 2010/07/31 16:08:48 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 <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>
50 <H2>NAME</H2><PRE>
51        <STRONG>mitem_current</STRONG> - set and get current_menu_item
52
53
54 </PRE>
55 <H2>SYNOPSIS</H2><PRE>
56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
57        int set_current_item(MENU *menu, const ITEM *item);
58        ITEM *current_item(const MENU *menu);
59        int set_top_row(MENU *menu, int row);
60        int top_row(const MENU *menu);
61        int item_index(const ITEM *item);
62
63
64 </PRE>
65 <H2>DESCRIPTION</H2><PRE>
66        The  function  <STRONG>set_current_item</STRONG> sets the current item (the
67        item on  which  the  menu  cursor  is  positioned).   <STRONG>cur-</STRONG>
68        <STRONG>rent_item</STRONG>  returns  a  pointer  to the current item in the
69        given menu.
70
71        The function <STRONG>set_top_row</STRONG> sets the top row of the  menu  to
72        show  the  given  row  (the top row is initially 0, and is
73        reset to this value whenever the <STRONG>O_ROWMAJOR</STRONG> option is tog-
74        gled).   The  item  leftmost on the given row becomes cur-
75        rent.  The function <STRONG>top_row</STRONG> returns the number of the  top
76        menu row being displayed.
77
78        The function <STRONG>item_index</STRONG> returns the (zero-origin) index of
79        <EM>item</EM> in the menu's item pointer list.
80
81
82 </PRE>
83 <H2>RETURN VALUE</H2><PRE>
84        <STRONG>current_item</STRONG> returns a pointer (which may  be  <STRONG>NULL</STRONG>).   It
85        does not set errno.
86
87        <STRONG>top_row</STRONG>  and  <STRONG>item_index</STRONG>  return  <STRONG>ERR</STRONG>  (the general <STRONG>curses</STRONG>
88        error value) if their <EM>menu</EM> parameter is <STRONG>NULL</STRONG>.
89
90        <STRONG>set_current_item</STRONG> and <STRONG>set_top_row</STRONG> return one of the follow-
91        ing:
92
93        <STRONG>E_OK</STRONG> The routine succeeded.
94
95        <STRONG>E_BAD_ARGUMENT</STRONG>
96             Routine  detected  an incorrect or out-of-range argu-
97             ment.
98
99        <STRONG>E_BAD_STATE</STRONG>
100             Routine was called from an initialization or termina-
101             tion function.
102
103        <STRONG>E_NOT_CONNECTED</STRONG>
104             No items are connected to the menu.
105
106        <STRONG>E_SYSTEM_ERROR</STRONG>
107             System error occurred (see <STRONG>errno</STRONG>).
108
109
110 </PRE>
111 <H2>SEE ALSO</H2><PRE>
112        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
113
114
115 </PRE>
116 <H2>NOTES</H2><PRE>
117        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
118        file <STRONG>&lt;curses.h&gt;</STRONG>.
119
120
121 </PRE>
122 <H2>PORTABILITY</H2><PRE>
123        These routines emulate the System V  menu  library.   They
124        were not supported on Version 7 or BSD versions.
125
126        The  SVr4 menu library documentation specifies the <STRONG>top_row</STRONG>
127        and <STRONG>index_item</STRONG> error value as -1 (which is  the  value  of
128        <STRONG>ERR</STRONG>).
129
130
131 </PRE>
132 <H2>AUTHORS</H2><PRE>
133        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
134        curses by Eric S. Raymond.
135
136
137
138                                                       <STRONG><A HREF="mitem_current.3x.html">mitem_current(3x)</A></STRONG>
139 </PRE>
140 <HR>
141 <ADDRESS>
142 Man(1) output converted with
143 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
144 </ADDRESS>
145 </BODY>
146 </HTML>