Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / b2cef93693cf7cfd01098c9b69603c90f0f4b803 / . / doc / html / man / mitem_current.3x.html
blob: 2ee61a2420148f06a79fc1082bf67d700876f817 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]1<!--
2 * t
3 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]4 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]30 * @Id: mitem_current.3x,v 1.13 2010/12/04 18:40:45 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]31-->
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]32<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]33<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]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">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]42<H1 class="no-header">mitem_current 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]50<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]51 <STRONG>mitem_current</STRONG> - set and get current_menu_item
52
53
54</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]55<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]65<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]83<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]111<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]116<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]122<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]132<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]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>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]140<div class="nav">
141<ul>
142<li><a href="#h2-NAME">NAME</a></li>
143<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
144<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
145<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
146<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
147<li><a href="#h2-NOTES">NOTES</a></li>
148<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
149<li><a href="#h2-AUTHORS">AUTHORS</a></li>
150</ul>
151</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]152</BODY>
153</HTML>