3 ****************************************************************************
4 * Copyright (c) 1998-2018,2019 Free Software Foundation, Inc. *
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: *
14 * The above copyright notice and this permission notice shall be included *
15 * in all copies or substantial portions of the Software. *
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. *
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 *
29 ****************************************************************************
30 * @Id: menu_mark.3x,v 1.14 2019/01/20 20:32:23 tom Exp @
32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
36 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
37 <TITLE>menu_mark 3x</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
42 <H1 class="no-header">menu_mark 3x</H1>
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>
49 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
50 <STRONG>set_menu_mark</STRONG>, <STRONG>menu_mark</STRONG> - get and set the menu mark string
53 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
54 <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
55 int set_menu_mark(MENU *menu, const char *mark);
56 const char *menu_mark(const MENU *menu);
59 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
60 In order to make menu selections visible on older terminals without
61 highlighting or color capability, the menu library marks selected items
62 in a menu with a prefix string.
64 The function <STRONG>set_menu_mark</STRONG> sets the mark string for the given menu.
65 Calling <STRONG>set_menu_mark</STRONG> with a null menu item will abolish the mark
66 string. Note that changing the length of the mark string for a menu
67 while the menu is posted is likely to produce unhelpful behavior.
69 The default string is "-" (a dash). Calling <STRONG>set_menu_mark</STRONG> with a non-
70 <STRONG>NULL</STRONG> menu argument will change this default.
72 The function <STRONG>menu_mark</STRONG> returns the menu's mark string (or <STRONG>NULL</STRONG> if there
76 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
77 The function <STRONG>menu_mark</STRONG> returns a pointer (which may be <STRONG>NULL</STRONG>). It does
80 The function <STRONG>set_menu_mark</STRONG> may return the following error codes:
82 <STRONG>E_OK</STRONG> The routine succeeded.
84 <STRONG>E_BAD_ARGUMENT</STRONG>
85 Routine detected an incorrect or out-of-range argument.
87 <STRONG>E_SYSTEM_ERROR</STRONG>
88 System error occurred (see <STRONG>errno(3)</STRONG>).
91 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
92 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
95 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
96 The header file <STRONG><menu.h></STRONG> automatically includes the header file
97 <STRONG><curses.h></STRONG>.
100 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
101 These routines emulate the System V menu library. They were not sup-
102 ported on Version 7 or BSD versions.
105 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
106 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
111 <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
115 <li><a href="#h2-NAME">NAME</a></li>
116 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
117 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
118 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
119 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
120 <li><a href="#h2-NOTES">NOTES</a></li>
121 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
122 <li><a href="#h2-AUTHORS">AUTHORS</a></li>