Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / 9b9f5e71c18a5d2317f7871a472b47d3d7efc0c4 / . / doc / html / man / menu_post.3x.html
blob: 6d48f77b05a7cc6bd94b7ee034a351b18c4f232c [file] [log] [blame]
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]1<!--
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]2 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]3 * Copyright 2018-2023,2024 Thomas E. Dickey *
4 * Copyright 1998-2016,2017 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 ****************************************************************************
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]30 * @Id: menu_post.3x,v 1.36 2024/03/16 15:35:01 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">
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]36<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37<TITLE>menu_post 3x 2024-03-16 ncurses 6.5 Library calls</TITLE>
38<link rel="author" href="mailto:bug-ncurses@gnu.org">
39
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]40</HEAD>
41<BODY>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]42<H1 class="no-header">menu_post 3x 2024-03-16 ncurses 6.5 Library calls</H1>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]43<PRE>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]44<STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG> Library calls <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]45
46
47
48
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]49</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>post_menu</STRONG>, <STRONG>unpost_menu</STRONG> - write or erase menus from associated
51 subwindows
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]52
53
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]54</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]55 <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]56
57 <STRONG>int</STRONG> <STRONG>post_menu(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
58 <STRONG>int</STRONG> <STRONG>unpost_menu(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]59
60
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]61</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62 The function <STRONG>post_menu</STRONG> displays a menu to its associated subwindow. To
63 trigger physical display of the subwindow, use <STRONG><A HREF="curs_refresh.3x.html">refresh(3x)</A></STRONG> or some
64 equivalent <STRONG>curses</STRONG> routine (the implicit <STRONG>doupdate</STRONG> triggered by an <STRONG>curses</STRONG>
65 input request will do). <STRONG>post_menu</STRONG> resets the selection status of all
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]66 items.
67
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]68 The function <STRONG>unpost_menu</STRONG> erases menu from its associated subwindow.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]69
70
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]71</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]72 These routines return one of the following:
73
74 <STRONG>E_OK</STRONG> The routine succeeded.
75
76 <STRONG>E_SYSTEM_ERROR</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]77 System error occurred (see <STRONG>errno(3)</STRONG>).
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]78
79 <STRONG>E_BAD_ARGUMENT</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]80 Routine detected an incorrect or out-of-range argument.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]81
82 <STRONG>E_POSTED</STRONG>
83 The menu has already been posted.
84
85 <STRONG>E_BAD_STATE</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]86 Routine was called from an initialization or termination function.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]87
88 <STRONG>E_NO_ROOM</STRONG>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]89 Menu is too large for its window. You should consider using
90 <STRONG>set_menu_format</STRONG> to solve the problem.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]91
92 <STRONG>E_NOT_POSTED</STRONG>
93 The menu has not been posted.
94
95 <STRONG>E_NOT_CONNECTED</STRONG>
96 No items are connected to the menu.
97
98
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]99</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
100 These routines emulate the System V menu library. They were not
101 supported on Version 7 or BSD versions.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]102
103
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]104</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
105 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
106 Raymond.
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]107
108
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]109</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
110 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]111
112
113
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]114ncurses 6.5 2024-03-16 <STRONG><A HREF="menu_post.3x.html">menu_post(3x)</A></STRONG>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]115</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]116<div class="nav">
117<ul>
118<li><a href="#h2-NAME">NAME</a></li>
119<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
120<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
121<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]122<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
123<li><a href="#h2-AUTHORS">AUTHORS</a></li>
micky3879b9f5e72025-07-08 18:04:53 -0400[diff] [blame^]124<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame]125</ul>
126</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]127</BODY>
128</HTML>