doc/html/man/menu_attributes.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_attributes.3x,v 1.17 2020/02/02 23:34:34 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_attributes 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_attributes 3x</H1>
  44 <PRE>
  45 <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>                                        <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
  46
  47
  48
  49
  50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
  51        <STRONG>menu_back</STRONG>,     <STRONG>menu_fore</STRONG>,     <STRONG>menu_grey</STRONG>,    <STRONG>menu_pad</STRONG>,    <STRONG>set_menu_back</STRONG>,
  52        <STRONG>set_menu_fore</STRONG>, <STRONG>set_menu_grey</STRONG>, <STRONG>set_menu_pad</STRONG> - color and  attribute  con-
  53        trol for menus
  54
  55
  56 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
  57        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  58        int set_menu_fore(MENU *menu, chtype attr);
  59        chtype menu_fore(const MENU *menu);
  60        int set_menu_back(MENU *menu, chtype attr);
  61        chtype menu_back(const MENU *menu);
  62        int set_menu_grey(MENU *menu, chtype attr);
  63        chtype menu_grey(const MENU *menu);
  64        int set_menu_pad(MENU *menu, int pad);
  65        int menu_pad(const MENU *menu);
  66
  67
  68 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  69        The  function <STRONG>set_menu_fore</STRONG> sets the foreground attribute of <EM>menu</EM>. This
  70        is the highlight used for selected menu items.  <STRONG>menu_fore</STRONG>  returns  the
  71        foreground attribute.  The default is <STRONG>A_REVERSE</STRONG>.
  72
  73        The  function <STRONG>set_menu_back</STRONG> sets the background attribute of <EM>menu</EM>. This
  74        is the highlight used for selectable (but not currently selected)  menu
  75        items.   The  function <STRONG>menu_back</STRONG> returns the background attribute.  The
  76        default is <STRONG>A_NORMAL</STRONG>.
  77
  78        The function <STRONG>set_menu_grey</STRONG> sets the grey attribute of <EM>menu</EM>. This is the
  79        highlight  used  for un-selectable menu items in menus that permit more
  80        than one selection.  The function <STRONG>menu_grey</STRONG> returns the grey attribute.
  81        The default is <STRONG>A_UNDERLINE</STRONG>.
  82
  83        The  function  <STRONG>set_menu_pad</STRONG>  sets  the character used to fill the space
  84        between the name and  description  parts  of  a  menu  item.   <STRONG>menu_pad</STRONG>
  85        returns the given menu's pad character.  The default is a blank.
  86
  87
  88 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  89        These routines return one of the following:
  90
  91        <STRONG>E_OK</STRONG> The routine succeeded.
  92
  93        <STRONG>E_SYSTEM_ERROR</STRONG>
  94             System error occurred (see <STRONG>errno(3)</STRONG>).
  95
  96        <STRONG>E_BAD_ARGUMENT</STRONG>
  97             Routine detected an incorrect or out-of-range argument.
  98
  99
 100 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 101        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>  and  related  pages  whose names begin "menu_" for detailed
 102        descriptions of the entry points.
 103
 104
 105 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 106        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
 107        <STRONG>&lt;curses.h&gt;</STRONG>.
 108
 109
 110 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 111        These  routines  emulate the System V menu library.  They were not sup-
 112        ported on Version 7 or BSD versions.
 113
 114
 115 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 116        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
 117        Raymond.
 118
 119
 120
 121                                                            <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
 122 </PRE>
 123 <div class="nav">
 124 <ul>
 125 <li><a href="#h2-NAME">NAME</a></li>
 126 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 127 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 128 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 129 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 130 <li><a href="#h2-NOTES">NOTES</a></li>
 131 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 132 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 133 </ul>
 134 </div>
 135 </BODY>
 136 </HTML>