Debian Codegraph @

upstream/debian-unstable/man3/mark.3menu

raw
1 .\"***************************************************************************
2 .\" Copyright 2018-2023,2024 Thomas E. Dickey *
3 .\" Copyright 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.37 2024/12/28 21:26:21 tom Exp $
31 .TH mark 3MENU 2024-12-28 "ncurses 6.6" "Library calls"
32 .SH NAME
33 \fBset_menu_mark\fP,
34 \fBmenu_mark\fP \-
35 get and set the menu mark string
36 .SH SYNOPSIS
37 .nf
38 \fB#include <menu.h>
39 .PP
40 \fBint set_menu_mark(MENU *\fImenu\fP, const char *\fImark\fP);
41 \fBconst char *menu_mark(const MENU *\fImenu\fP);
42 .fi
43 .SH DESCRIPTION
44 In order to make menu selections visible on older terminals without
45 highlighting or color capability, the menu library marks selected items
46 in a menu with a prefix string.
47 .PP
48 The function \fBset_menu_mark\fP sets the mark string for the given menu.
49 Calling \fBset_menu_mark\fP with a null menu item will abolish the mark string.
50 Note that changing the length of the mark string for a menu while the
51 menu is posted is likely to produce unhelpful behavior.
52 .PP
53 The default string is "\-" (a dash).
54 Calling \fBset_menu_mark\fP with a
55 .IR non- NULL
56 menu argument will change this default.
57 .PP
58 The function \fBmenu_mark\fP returns the menu's mark string (or
59 .I NULL
60 if there is none).
61 .SH RETURN VALUE
62 The function \fBmenu_mark\fP returns a pointer (which may be
63 .IR NULL ")."
64 It does not set \fBerrno\fP.
65 .PP
66 The function \fBset_menu_mark\fP may return the following error codes:
67 .TP 5
68 .B E_OK
69 The routine succeeded.
70 .TP 5
71 .B E_BAD_ARGUMENT
72 Routine detected an incorrect or out-of-range argument.
73 .TP 5
74 .B E_SYSTEM_ERROR
75 System error occurred (see \fBerrno\fP(3)).
76 .SH PORTABILITY
77 These routines emulate the System V menu library.
78 They were not supported on
79 Version 7 or BSD versions.
80 .SH AUTHORS
81 Juergen Pfeifer.
82 Manual pages and adaptation for new curses by Eric S. Raymond.
83 .SH SEE ALSO
84 \fB\%ncurses\fP(3NCURSES),
85 \fB\%menu\fP(3MENU)