62f6d39c45c574abd41abeefab68be069b9ad058
[ncurses.git] / man / menu_mark.3x
1 '\" t
2 .TH menu_mark 3X ""
3 .SH NAME
4 \fBmenu_mark\fR - get and set the menu mark string
5 .SH SYNOPSIS
6 \fB#include <menu.h>\fR
7 .br
8 int set_menu_mark(MENU *menu, const char *mark);
9 .br
10 const char *menu_mark(const MENU *menu);
11 .br
12 .SH DESCRIPTION
13 In order to make menu selections visible on older terminals without
14 highlighting or color capability, the menu library marks selected items
15 in a menu with a prefix string. 
16
17 The function \fBset_menu_mark\fR sets the mark string for the given menu.
18 Calling \fBset_menu_mark\fR with a null menu item will abolish the mark string.
19 Note that changing the length of the mark string for a menu while the
20 menu is posted is likely to produce unhelpful behavior.
21
22 The default string is "-" (a dash). Calling \fBset_menu_mark\fR with
23 a \fBNULL\fR menu argument will change this default.
24
25 The function \fBmenu_mark\fR returns the menu's mark string (or \fBNULL\fR if
26 there is none).
27 .SH RETURN VALUE
28 The function \fBmenu_mark\fR returns \fBNULL\fR on error.  The function
29 \fBset_menu_mark\fR may return the following error codes:
30 .TP 5
31 \fBE_OK\fR
32 The routine succeeded.
33 .TP 5
34 \fBE_SYSTEM_ERROR\fR
35 System error occurred (see \fBerrno\fR).
36 .TP 5
37 \fBE_BAD_ARGUMENT\fR
38 Routine detected an incorrect or out-of-range argument.
39 .SH SEE ALSO
40 \fBcurses\fR(3X), \fBmenu\fR(3X).
41 .SH NOTES
42 The header file \fB<menu.h>\fR automatically includes the header file
43 \fB<curses.h>\fR.
44 .SH PORTABILITY
45 These routines emulate the System V menu library.  They were not supported on
46 Version 7 or BSD versions.
47 .SH AUTHORS
48 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
49 S. Raymond.
50 .\"#
51 .\"# The following sets edit modes for GNU EMACS
52 .\"# Local Variables:
53 .\"# mode:nroff
54 .\"# fill-column:79
55 .\"# End: