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

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright (c) 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   * @Id: menu_mark.3x,v 1.12 2015/12/05 23:42:45 tom Exp @
  31 -->
  32 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
  33 <HTML>
  34 <HEAD>
  35 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
  36 <meta name="generator" content="Manpage converted by man2html - see http://invisible-island.net/scripts/readme.html#others_scripts">
  37 <TITLE>menu_mark 3x</TITLE>
  38 <link rev=made href="mailto:bug-ncurses@gnu.org">
  39 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
  40 </HEAD>
  41 <BODY>
  42 <H1 class="no-header">menu_mark 3x</H1>
  43 <PRE>
  44 <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>                                             <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>set_menu_mark</STRONG>,  <STRONG>menu_mark</STRONG>  -  get  and  set  the menu mark
  52        string
  53
  54
  55 </PRE>
  56 <H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  57        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  58        int set_menu_mark(MENU *menu, const char *mark);
  59        const char *menu_mark(const MENU *menu);
  60
  61
  62 </PRE>
  63 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  64        In order to make menu selections visible on  older  termi-
  65        nals  without  highlighting  or color capability, the menu
  66        library marks selected items  in  a  menu  with  a  prefix
  67        string.
  68
  69        The  function  <STRONG>set_menu_mark</STRONG>  sets the mark string for the
  70        given menu.  Calling <STRONG>set_menu_mark</STRONG> with a null  menu  item
  71        will  abolish  the  mark  string.   Note that changing the
  72        length of the mark string for a menu  while  the  menu  is
  73        posted is likely to produce unhelpful behavior.
  74
  75        The  default string is "-" (a dash). Calling <STRONG>set_menu_mark</STRONG>
  76        with a non-<STRONG>NULL</STRONG> menu argument will change this default.
  77
  78        The function <STRONG>menu_mark</STRONG> returns the menu's mark string  (or
  79        <STRONG>NULL</STRONG> if there is none).
  80
  81
  82 </PRE>
  83 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  84        The  function  <STRONG>menu_mark</STRONG>  returns  a pointer (which may be
  85        <STRONG>NULL</STRONG>).  It does not set errno.
  86
  87        The function <STRONG>set_menu_mark</STRONG> may return the following  error
  88        codes:
  89
  90        <STRONG>E_OK</STRONG> The routine succeeded.
  91
  92        <STRONG>E_BAD_ARGUMENT</STRONG>
  93             Routine  detected  an incorrect or out-of-range argu-
  94             ment.
  95
  96        <STRONG>E_SYSTEM_ERROR</STRONG>
  97             System error occurred (see <STRONG>errno</STRONG>).
  98
  99
 100 </PRE>
 101 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 102        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
 103
 104
 105 </PRE>
 106 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 107        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
 108        file <STRONG>&lt;curses.h&gt;</STRONG>.
 109
 110
 111 </PRE>
 112 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 113        These  routines  emulate  the System V menu library.  They
 114        were not supported on Version 7 or BSD versions.
 115
 116
 117 </PRE>
 118 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 119        Juergen Pfeifer.  Manual  pages  and  adaptation  for  new
 120        curses by Eric S. Raymond.
 121
 122
 123
 124                                                           <STRONG><A HREF="menu_mark.3x.html">menu_mark(3x)</A></STRONG>
 125 </PRE>
 126 <div class="nav">
 127 <ul>
 128 <li><a href="#h2-NAME">NAME</a></li>
 129 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 130 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 131 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 132 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 133 <li><a href="#h2-NOTES">NOTES</a></li>
 134 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 135 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 136 </ul>
 137 </div>
 138 </BODY>
 139 </HTML>