doc/html/man/menu_mark.3x.html

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   * t
   4   ****************************************************************************
   5   * Copyright (c) 1998 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.6 1998/11/29 01:10:03 Rick.Ohnemus Exp @
  32 -->
  33 <HTML>
  34 <HEAD>
  35 <TITLE>menu_mark 3x</TITLE>
  36 <link rev=made href="mailto:bug-ncurses@gnu.org">
  37 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  38 </HEAD>
  39 <BODY>
  40 <H1>menu_mark 3x</H1>
  41 <HR>
  42 <PRE>
  43 <!-- Manpage converted by man2html 3.0.1 -->
  44
  45 </PRE>
  46 <H2>NAME</H2><PRE>
  47        <STRONG>menu_mark</STRONG> - get and set the menu mark string
  48
  49
  50 </PRE>
  51 <H2>SYNOPSIS</H2><PRE>
  52        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  53        int set_menu_mark(MENU *menu, const char *mark);
  54        const char *menu_mark(const MENU *menu);
  55
  56
  57 </PRE>
  58 <H2>DESCRIPTION</H2><PRE>
  59        In  order  to make menu selections visible on older termi-
  60        nals without highlighting or color  capability,  the  menu
  61        library  marks  selected  items  in  a  menu with a prefix
  62        string.
  63
  64        The function <STRONG>set_menu_mark</STRONG> sets the mark  string  for  the
  65        given  menu.   Calling <STRONG>set_menu_mark</STRONG> with a null menu item
  66        will abolish the mark  string.   Note  that  changing  the
  67        length  of  the  mark  string for a menu while the menu is
  68        posted is likely to produce unhelpful behavior.
  69
  70        The default string is "-" (a dash). Calling  <STRONG>set_menu_mark</STRONG>
  71        with a <STRONG>NULL</STRONG> menu argument will change this default.
  72
  73        The  function <STRONG>menu_mark</STRONG> returns the menu's mark string (or
  74        <STRONG>NULL</STRONG> if there is none).
  75
  76
  77 </PRE>
  78 <H2>RETURN VALUE</H2><PRE>
  79        The function <STRONG>menu_mark</STRONG> returns <STRONG>NULL</STRONG> on error.   The  func-
  80        tion <STRONG>set_menu_mark</STRONG> may return the following error codes:
  81
  82        <STRONG>E_OK</STRONG> The routine succeeded.
  83
  84        <STRONG>E_SYSTEM_ERROR</STRONG>
  85             System error occurred (see <STRONG>errno</STRONG>).
  86
  87        <STRONG>E_BAD_ARGUMENT</STRONG>
  88             Routine  detected  an incorrect or out-of-range argu-
  89             ment.
  90
  91
  92 </PRE>
  93 <H2>SEE ALSO</H2><PRE>
  94        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
  95
  96
  97 </PRE>
  98 <H2>NOTES</H2><PRE>
  99        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
 100        file <STRONG>&lt;curses.h&gt;</STRONG>.
 101
 102
 103 </PRE>
 104 <H2>PORTABILITY</H2><PRE>
 105        These  routines  emulate  the System V menu library.  They
 106        were not supported on Version 7 or BSD versions.
 107
 108
 109 </PRE>
 110 <H2>AUTHORS</H2><PRE>
 111        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
 112        curses by Eric S. Raymond.
 113
 114 </PRE>
 115 <HR>
 116 <ADDRESS>
 117 Man(1) output converted with
 118 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 119 </ADDRESS>
 120 </BODY>
 121 </HTML>