Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / ae271bcd1ff942b3c4cb099f04bb5882f812da13 / . / doc / html / man / menu_cursor.3x.html
blob: e5c29de0e614c905a661cfd043a401a191347e84 [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: menu_cursor.3x,v 1.8 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>menu_cursor 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">menu_cursor 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="menu_cursor.3x.html">menu_cursor(3x)</A></STRONG> <STRONG><A HREF="menu_cursor.3x.html">menu_cursor(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>menu_cursor</STRONG> - position a menu's cursor
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 pos_menu_cursor(const MENU *menu);
58
59
60</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]61<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]62 The function <STRONG>pos_menu_cursor</STRONG> restores the cursor to the
63 current position associated with the menu's selected item.
64 This is useful after <STRONG>curses</STRONG> routines have been called to
65 do screen-painting in response to a menu select.
66
67
68</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]69<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]70 This routine returns one of the following:
71
72 <STRONG>E_OK</STRONG> The routine succeeded.
73
74 <STRONG>E_SYSTEM_ERROR</STRONG>
75 System error occurred (see <STRONG>errno</STRONG>).
76
77 <STRONG>E_BAD_ARGUMENT</STRONG>
78 Routine detected an incorrect or out-of-range argu-
79 ment.
80
81 <STRONG>E_NOT_POSTED</STRONG>
82 The menu has not been posted.
83
84
85</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]86<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]87 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
88
89
90</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]91<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]92 The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
93 file <STRONG>&lt;curses.h&gt;</STRONG>.
94
95
96</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]97<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]98 These routines emulate the System V menu library. They
99 were not supported on Version 7 or BSD versions.
100
101
102</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]103<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]104 Juergen Pfeifer. Manual pages and adaptation for new
105 curses by Eric S. Raymond.
106
107
108
109 <STRONG><A HREF="menu_cursor.3x.html">menu_cursor(3x)</A></STRONG>
110</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]111<div class="nav">
112<ul>
113<li><a href="#h2-NAME">NAME</a></li>
114<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
115<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
116<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
117<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
118<li><a href="#h2-NOTES">NOTES</a></li>
119<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
120<li><a href="#h2-AUTHORS">AUTHORS</a></li>
121</ul>
122</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]123</BODY>
124</HTML>