blob: ae275bfaf135c134753f2a3061a10a5cca05d9a9 [file] [log] [blame]
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05301<!--
2 * t
3 ****************************************************************************
Steve Kondikae271bc2015-11-15 02:50:53 +01004 * Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. *
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +05305 * *
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 +010030 * @Id: menu_post.3x,v 1.11 2010/12/04 18:40:45 tom Exp @
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053031-->
Steve Kondikae271bc2015-11-15 02:50:53 +010032<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053033<HTML>
34<HEAD>
Steve Kondikae271bc2015-11-15 02:50:53 +010035<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 +053037<TITLE>menu_post 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 +010042<H1 class="no-header">menu_post 3x</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053043<PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053044<STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG> <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>
45
46
47
48
49</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010050<H2><a name="h2-NAME">NAME</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053051 <STRONG>menu_post</STRONG> - write or erase menus from associated subwin-
52 dows
53
54
55</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010056<H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053057 <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
58 int post_menu(MENU *menu);
59 int unpost_menu(MENU *menu);
60
61
62</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010063<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053064 The function <STRONG>post_menu</STRONG> displays a menu to its associated
65 subwindow. To trigger physical display of the subwindow,
66 use <STRONG>refresh</STRONG> or some equivalent <STRONG>curses</STRONG> routine (the
67 implicit <STRONG>doupdate</STRONG> triggered by an <STRONG>curses</STRONG> input request
68 will do). <STRONG>post_menu</STRONG> resets the selection status of all
69 items.
70
71 The function <STRONG>unpost_menu</STRONG> erases menu from its associated
72 subwindow.
73
74
75</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +010076<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +053077 These routines return one of the following:
78
79 <STRONG>E_OK</STRONG> The routine succeeded.
80
81 <STRONG>E_SYSTEM_ERROR</STRONG>
82 System error occurred (see <STRONG>errno</STRONG>).
83
84 <STRONG>E_BAD_ARGUMENT</STRONG>
85 Routine detected an incorrect or out-of-range argu-
86 ment.
87
88 <STRONG>E_POSTED</STRONG>
89 The menu has already been posted.
90
91 <STRONG>E_BAD_STATE</STRONG>
92 Routine was called from an initialization or termina-
93 tion function.
94
95 <STRONG>E_NO_ROOM</STRONG>
96 Menu is too large for its window. You should consider
97 to use <STRONG>set_menu_format()</STRONG> to solve the problem.
98
99 <STRONG>E_NOT_POSTED</STRONG>
100 The menu has not been posted.
101
102 <STRONG>E_NOT_CONNECTED</STRONG>
103 No items are connected to the menu.
104
105
106</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100107<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530108 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
109
110
111</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100112<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530113 The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
114 file <STRONG>&lt;curses.h&gt;</STRONG>.
115
116
117</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100118<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530119 These routines emulate the System V menu library. They
120 were not supported on Version 7 or BSD versions.
121
122
123</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100124<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530125 Juergen Pfeifer. Manual pages and adaptation for new
126 curses by Eric S. Raymond.
127
128
129
130 <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>
131</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100132<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>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530144</BODY>
145</HTML>