ncurses 6.0 - patch 20151205
[ncurses.git] / man / menu_mark.3x
1 '\" t
2 .\"***************************************************************************
3 .\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
4 .\"                                                                          *
5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
6 .\" copy of this software and associated documentation files (the            *
7 .\" "Software"), to deal in the Software without restriction, including      *
8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
10 .\" copies of the Software, and to permit persons to whom the Software is    *
11 .\" furnished to do so, subject to the following conditions:                 *
12 .\"                                                                          *
13 .\" The above copyright notice and this permission notice shall be included  *
14 .\" in all copies or substantial portions of the Software.                   *
15 .\"                                                                          *
16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
23 .\"                                                                          *
24 .\" Except as contained in this notice, the name(s) of the above copyright   *
25 .\" holders shall not be used in advertising or otherwise to promote the     *
26 .\" sale, use or other dealings in this Software without prior written       *
27 .\" authorization.                                                           *
28 .\"***************************************************************************
29 .\"
30 .\" $Id: menu_mark.3x,v 1.12 2015/12/05 23:42:45 tom Exp $
31 .TH menu_mark 3X ""
32 .SH NAME
33 \fBset_menu_mark\fP,
34 \fBmenu_mark\fR \- get and set the menu mark string
35 .SH SYNOPSIS
36 \fB#include <menu.h>\fR
37 .br
38 int set_menu_mark(MENU *menu, const char *mark);
39 .br
40 const char *menu_mark(const MENU *menu);
41 .br
42 .SH DESCRIPTION
43 In order to make menu selections visible on older terminals without
44 highlighting or color capability, the menu library marks selected items
45 in a menu with a prefix string.
46 .PP
47 The function \fBset_menu_mark\fR sets the mark string for the given menu.
48 Calling \fBset_menu_mark\fR with a null menu item will abolish the mark string.
49 Note that changing the length of the mark string for a menu while the
50 menu is posted is likely to produce unhelpful behavior.
51 .PP
52 The default string is "\-" (a dash). Calling \fBset_menu_mark\fR with
53 a non-\fBNULL\fR menu argument will change this default.
54 .PP
55 The function \fBmenu_mark\fR returns the menu's mark string (or \fBNULL\fR if
56 there is none).
57 .SH RETURN VALUE
58 The function \fBmenu_mark\fR returns a pointer (which may be \fBNULL\fR).
59 It does not set errno.
60 .PP
61 The function \fBset_menu_mark\fR may return the following error codes:
62 .TP 5
63 .B E_OK
64 The routine succeeded.
65 .TP 5
66 .B E_BAD_ARGUMENT
67 Routine detected an incorrect or out-of-range argument.
68 .TP 5
69 .B E_SYSTEM_ERROR
70 System error occurred (see \fBerrno\fR).
71 .SH SEE ALSO
72 \fBcurses\fR(3X), \fBmenu\fR(3X).
73 .SH NOTES
74 The header file \fB<menu.h>\fR automatically includes the header file
75 \fB<curses.h>\fR.
76 .SH PORTABILITY
77 These routines emulate the System V menu library.  They were not supported on
78 Version 7 or BSD versions.
79 .SH AUTHORS
80 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
81 S. Raymond.