3 ****************************************************************************
4 * Copyright 2018-2019,2020 Thomas E. Dickey *
5 * Copyright 1998-2010,2015 Free Software Foundation, Inc. *
7 * Permission is hereby granted, free of charge, to any person obtaining a *
8 * copy of this software and associated documentation files (the *
9 * "Software"), to deal in the Software without restriction, including *
10 * without limitation the rights to use, copy, modify, merge, publish, *
11 * distribute, distribute with modifications, sublicense, and/or sell *
12 * copies of the Software, and to permit persons to whom the Software is *
13 * furnished to do so, subject to the following conditions: *
15 * The above copyright notice and this permission notice shall be included *
16 * in all copies or substantial portions of the Software. *
18 * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
19 * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
20 * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
21 * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
22 * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
23 * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
24 * THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
26 * Except as contained in this notice, the name(s) of the above copyright *
27 * holders shall not be used in advertising or otherwise to promote the *
28 * sale, use or other dealings in this Software without prior written *
30 ****************************************************************************
31 * @Id: menu_mark.3x,v 1.16 2020/03/28 19:06:28 tom Exp @
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>menu_mark 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
43 <H1 class="no-header">menu_mark 3x</H1>
45 <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG> <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51 <STRONG>set_menu_mark</STRONG>, <STRONG>menu_mark</STRONG> - get and set the menu mark string
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
56 int set_menu_mark(MENU *menu, const char *mark);
57 const char *menu_mark(const MENU *menu);
60 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
61 In order to make menu selections visible on older terminals without
62 highlighting or color capability, the menu library marks selected items
63 in a menu with a prefix string.
65 The function <STRONG>set_menu_mark</STRONG> sets the mark string for the given menu.
66 Calling <STRONG>set_menu_mark</STRONG> with a null menu item will abolish the mark
67 string. Note that changing the length of the mark string for a menu
68 while the menu is posted is likely to produce unhelpful behavior.
70 The default string is "-" (a dash). Calling <STRONG>set_menu_mark</STRONG> with a non-
71 <STRONG>NULL</STRONG> menu argument will change this default.
73 The function <STRONG>menu_mark</STRONG> returns the menu's mark string (or <STRONG>NULL</STRONG> if there
77 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
78 The function <STRONG>menu_mark</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It does
79 not set <STRONG>errno</STRONG>.
81 The function <STRONG>set_menu_mark</STRONG> may return the following error codes:
83 <STRONG>E_OK</STRONG> The routine succeeded.
85 <STRONG>E_BAD_ARGUMENT</STRONG>
86 Routine detected an incorrect or out-of-range argument.
88 <STRONG>E_SYSTEM_ERROR</STRONG>
89 System error occurred (see <STRONG>errno(3)</STRONG>).
92 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
93 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
96 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
97 The header file <STRONG><menu.h></STRONG> automatically includes the header file
98 <STRONG><curses.h></STRONG>.
101 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
102 These routines emulate the System V menu library. They were not sup-
103 ported on Version 7 or BSD versions.
106 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
107 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
112 <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
116 <li><a href="#h2-NAME">NAME</a></li>
117 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
118 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
119 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
120 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
121 <li><a href="#h2-NOTES">NOTES</a></li>
122 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
123 <li><a href="#h2-AUTHORS">AUTHORS</a></li>