man/menu_mark.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright 2018-2022,2023 Thomas E. Dickey                                *
   4 .\" Copyright 1998-2010,2015 Free Software Foundation, Inc.                  *
   5 .\"                                                                          *
   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:                 *
  13 .\"                                                                          *
  14 .\" The above copyright notice and this permission notice shall be included  *
  15 .\" in all copies or substantial portions of the Software.                   *
  16 .\"                                                                          *
  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.                               *
  24 .\"                                                                          *
  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       *
  28 .\" authorization.                                                           *
  29 .\"***************************************************************************
  30 .\"
  31 .\" $Id: menu_mark.3x,v 1.25 2023/07/01 15:46:10 tom Exp $
  32 .TH menu_mark 3X 2023-07-01 "ncurses 6.4" "Library calls"
  33 .SH NAME
  34 \fBset_menu_mark\fP,
  35 \fBmenu_mark\fP \- get and set the menu mark string
  36 .SH SYNOPSIS
  37 \fB#include <menu.h>\fP
  38 .sp
  39 \fBint set_menu_mark(MENU *\fImenu\fB, const char *\fImark\fB);\fR
  40 .br
  41 \fBconst char *menu_mark(const MENU *\fImenu\fB);\fR
  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\fP sets the mark string for the given menu.
  48 Calling \fBset_menu_mark\fP 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).
  53 Calling \fBset_menu_mark\fP with
  54 a non-\fBNULL\fP menu argument will change this default.
  55 .PP
  56 The function \fBmenu_mark\fP returns the menu's mark string (or \fBNULL\fP if
  57 there is none).
  58 .SH RETURN VALUE
  59 The function \fBmenu_mark\fP returns a pointer (which may be \fBNULL\fP).
  60 It does not set \fBerrno\fP.
  61 .PP
  62 The function \fBset_menu_mark\fP may return the following error codes:
  63 .TP 5
  64 .B E_OK
  65 The routine succeeded.
  66 .TP 5
  67 .B E_BAD_ARGUMENT
  68 Routine detected an incorrect or out-of-range argument.
  69 .TP 5
  70 .B E_SYSTEM_ERROR
  71 System error occurred (see \fBerrno\fP(3)).
  72 .SH SEE ALSO
  73 \fBcurses\fP(3X), \fBmenu\fP(3X).
  74 .SH NOTES
  75 The header file \fB<menu.h>\fP automatically includes the header file
  76 \fB<curses.h>\fP.
  77 .SH PORTABILITY
  78 These routines emulate the System V menu library.
  79 They were not supported on
  80 Version 7 or BSD versions.
  81 .SH AUTHORS
  82 Juergen Pfeifer.
  83 Manual pages and adaptation for new curses by Eric S. Raymond.