Gitiles
Code Review Sign In
gerrit.omnirom.org / android_external_libncurses / ae271bcd1ff942b3c4cb099f04bb5882f812da13 / . / doc / html / man / menu_mark.3x.html
blob: b0e678c2031cb0182a42722a2187269426d6516b [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_mark.3x,v 1.11 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_mark 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_mark 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_mark.3x.html">menu_mark(3x)</A></STRONG> <STRONG><A HREF="menu_mark.3x.html">menu_mark(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_mark</STRONG> - get and set the menu mark string
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_menu_mark(MENU *menu, const char *mark);
58 const char *menu_mark(const MENU *menu);
59
60
61</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]62<H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]63 In order to make menu selections visible on older termi-
64 nals without highlighting or color capability, the menu
65 library marks selected items in a menu with a prefix
66 string.
67
68 The function <STRONG>set_menu_mark</STRONG> sets the mark string for the
69 given menu. Calling <STRONG>set_menu_mark</STRONG> with a null menu item
70 will abolish the mark string. Note that changing the
71 length of the mark string for a menu while the menu is
72 posted is likely to produce unhelpful behavior.
73
74 The default string is "-" (a dash). Calling <STRONG>set_menu_mark</STRONG>
75 with a non-<STRONG>NULL</STRONG> menu argument will change this default.
76
77 The function <STRONG>menu_mark</STRONG> returns the menu's mark string (or
78 <STRONG>NULL</STRONG> if there is none).
79
80
81</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]82<H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]83 The function <STRONG>menu_mark</STRONG> returns a pointer (which may be
84 <STRONG>NULL</STRONG>). It does not set errno.
85
86 The function <STRONG>set_menu_mark</STRONG> may return the following error
87 codes:
88
89 <STRONG>E_OK</STRONG> The routine succeeded.
90
91 <STRONG>E_BAD_ARGUMENT</STRONG>
92 Routine detected an incorrect or out-of-range argu-
93 ment.
94
95 <STRONG>E_SYSTEM_ERROR</STRONG>
96 System error occurred (see <STRONG>errno</STRONG>).
97
98
99</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]100<H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]101 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
102
103
104</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]105<H2><a name="h2-NOTES">NOTES</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]106 The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
107 file <STRONG>&lt;curses.h&gt;</STRONG>.
108
109
110</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]111<H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]112 These routines emulate the System V menu library. They
113 were not supported on Version 7 or BSD versions.
114
115
116</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]117<H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]118 Juergen Pfeifer. Manual pages and adaptation for new
119 curses by Eric S. Raymond.
120
121
122
123 <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
124</PRE>
Steve Kondikae271bc2015-11-15 02:50:53 +0100[diff] [blame^]125<div class="nav">
126<ul>
127<li><a href="#h2-NAME">NAME</a></li>
128<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
129<li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
130<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
131<li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
132<li><a href="#h2-NOTES">NOTES</a></li>
133<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
134<li><a href="#h2-AUTHORS">AUTHORS</a></li>
135</ul>
136</div>
Amit Daniel Kachhape6a01f52011-07-20 11:45:59 +0530[diff] [blame]137</BODY>
138</HTML>