doc/html/man/menu_attributes.3x.html

   1 <!--
   2   * t
   3   ****************************************************************************
   4   * Copyright (c) 1998-2008,2010 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_attributes.3x,v 1.12 2010/12/04 18:40: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_attributes 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>menu_attributes 3x</H1>
  43 <HR>
  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>
  51 <H2><a name="h2-NAME">NAME</a></H2><PRE>
  52        <STRONG>menu_attributes</STRONG> - color and attribute control for menus
  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_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>
  69 <H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
  70        The  function  <STRONG>set_menu_fore</STRONG> sets the foreground attribute
  71        of <EM>menu</EM>. This is the  highlight  used  for  selected  menu
  72        items.   <STRONG>menu_fore</STRONG>  returns the foreground attribute.  The
  73        default is <STRONG>A_REVERSE</STRONG>.
  74
  75        The function <STRONG>set_menu_back</STRONG> sets the  background  attribute
  76        of  <EM>menu</EM>.  This  is the highlight used for selectable (but
  77        not  currently  selected)  menu   items.    The   function
  78        <STRONG>menu_back</STRONG>  returns  the background attribute.  The default
  79        is <STRONG>A_NORMAL</STRONG>.
  80
  81        The function <STRONG>set_menu_grey</STRONG>  sets  the  grey  attribute  of
  82        <EM>menu</EM>.  This  is  the highlight used for un-selectable menu
  83        items in menus that permit more than one  selection.   The
  84        function   <STRONG>menu_grey</STRONG>  returns  the  grey  attribute.   The
  85        default is <STRONG>A_UNDERLINE</STRONG>.
  86
  87        The function <STRONG>set_menu_pad</STRONG> sets the character used to  fill
  88        the space between the name and description parts of a menu
  89        item.  <STRONG>menu_pad</STRONG> returns the given  menu's  pad  character.
  90        The default is a blank.
  91
  92
  93 </PRE>
  94 <H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
  95        These routines return one of the following:
  96
  97        <STRONG>E_OK</STRONG> The routine succeeded.
  98
  99        <STRONG>E_SYSTEM_ERROR</STRONG>
 100             System error occurred (see <STRONG>errno</STRONG>).
 101
 102        <STRONG>E_BAD_ARGUMENT</STRONG>
 103             Routine  detected  an incorrect or out-of-range argu-
 104             ment.
 105
 106
 107 </PRE>
 108 <H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
 109        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for
 110        detailed descriptions of the entry points.
 111
 112
 113 </PRE>
 114 <H2><a name="h2-NOTES">NOTES</a></H2><PRE>
 115        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
 116        file <STRONG>&lt;curses.h&gt;</STRONG>.
 117
 118
 119 </PRE>
 120 <H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
 121        These routines emulate the System V  menu  library.   They
 122        were not supported on Version 7 or BSD versions.
 123
 124
 125 </PRE>
 126 <H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
 127        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
 128        curses by Eric S. Raymond.
 129
 130
 131
 132                                                     <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
 133 </PRE>
 134 <div class="nav">
 135 <ul>
 136 <li><a href="#h2-NAME">NAME</a></li>
 137 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
 138 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
 139 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
 140 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
 141 <li><a href="#h2-NOTES">NOTES</a></li>
 142 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
 143 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
 144 </ul>
 145 </div>
 146 </BODY>
 147 </HTML>