ncurses 6.2 - patch 20210619
[ncurses.git] / doc / html / man / menu_mark.3x.html
1 <!--
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: menu_mark.3x,v 1.18 2020/10/24 08:59:04 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>menu_mark 3X</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">menu_mark 3X</H1>
44 <PRE>
45 <B><A HREF="menu_mark.3X.html">menu_mark(3X)</A></B>                                                    <B><A HREF="menu_mark.3X.html">menu_mark(3X)</A></B>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <B>set_menu_mark</B>, <B>menu_mark</B> - get and set the menu mark string
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <B>#include</B> <B>&lt;menu.h&gt;</B>
56
57        <B>int</B> <B>set_menu_mark(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>const</B> <B>char</B> <B>*</B><I>mark</I><B>);</B>
58        <B>const</B> <B>char</B> <B>*menu_mark(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
59
60
61 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
62        In  order  to  make  menu selections visible on older terminals without
63        highlighting or color capability, the menu library marks selected items
64        in a menu with a prefix string.
65
66        The  function  <B>set_menu_mark</B>  sets  the mark string for the given menu.
67        Calling <B>set_menu_mark</B> with a null  menu  item  will  abolish  the  mark
68        string.   Note  that  changing the length of the mark string for a menu
69        while the menu is posted is likely to produce unhelpful behavior.
70
71        The default string is "-" (a dash).  Calling <B>set_menu_mark</B> with a  non-
72        <B>NULL</B> menu argument will change this default.
73
74        The function <B>menu_mark</B> returns the menu's mark string (or <B>NULL</B> if there
75        is none).
76
77
78 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
79        The function <B>menu_mark</B> returns a pointer (which may be <B>NULL</B>).  It  does
80        not set <B>errno</B>.
81
82        The function <B>set_menu_mark</B> may return the following error codes:
83
84        <B>E_OK</B> The routine succeeded.
85
86        <B>E_BAD_ARGUMENT</B>
87             Routine detected an incorrect or out-of-range argument.
88
89        <B>E_SYSTEM_ERROR</B>
90             System error occurred (see <B>errno(3)</B>).
91
92
93 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
94        <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
95
96
97 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
98        The  header  file  <B>&lt;menu.h&gt;</B>  automatically  includes  the  header  file
99        <B>&lt;curses.h&gt;</B>.
100
101
102 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
103        These routines emulate the  System  V  menu  library.   They  were  not
104        supported on Version 7 or BSD versions.
105
106
107 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
108        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
109        Raymond.
110
111
112
113                                                                  <B><A HREF="menu_mark.3X.html">menu_mark(3X)</A></B>
114 </PRE>
115 <div class="nav">
116 <ul>
117 <li><a href="#h2-NAME">NAME</a></li>
118 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
119 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
120 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
121 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
122 <li><a href="#h2-NOTES">NOTES</a></li>
123 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
124 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
125 </ul>
126 </div>
127 </BODY>
128 </HTML>