2 ****************************************************************************
3 * Copyright 2018-2023,2024 Thomas E. Dickey *
4 * Copyright 1998-2010,2015 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.35 2024/03/16 15:35:01 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 2024-03-16 ncurses 6.5 Library calls</TITLE>
38 <link rel="author" href="mailto:bug-ncurses@gnu.org">
42 <H1 class="no-header">menu_mark 3x 2024-03-16 ncurses 6.5 Library calls</H1>
44 <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG> Library calls <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>
56 <STRONG>int</STRONG> <STRONG>set_menu_mark(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*</STRONG><EM>mark</EM><STRONG>);</STRONG>
57 <STRONG>const</STRONG> <STRONG>char</STRONG> <STRONG>*menu_mark(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
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-PORTABILITY">PORTABILITY</a></H2><PRE>
93 These routines emulate the System V menu library. They were not
94 supported on Version 7 or BSD versions.
97 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
98 Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S.
102 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
103 <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>
107 ncurses 6.5 2024-03-16 <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
111 <li><a href="#h2-NAME">NAME</a></li>
112 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
113 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
114 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
115 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
116 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
117 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>