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

   1 <!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">
   2 <!--
   3   * t
   4   ****************************************************************************
   5   * Copyright (c) 1998-2008,2010 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.12 2010/12/04 18:40:45 tom Exp @
  32 -->
  33 <HTML>
  34 <HEAD>
  35 <TITLE>menu_attributes 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_attributes 3x</H1>
  41 <HR>
  42 <PRE>
  43 <!-- Manpage converted by man2html 3.0.1 -->
  44 <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>                                 <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
  45
  46
  47
  48
  49 </PRE>
  50 <H2>NAME</H2><PRE>
  51        <STRONG>menu_attributes</STRONG> - color and attribute control for menus
  52
  53
  54 </PRE>
  55 <H2>SYNOPSIS</H2><PRE>
  56        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
  57        int set_menu_fore(MENU *menu, chtype attr);
  58        chtype menu_fore(const MENU *menu);
  59        int set_menu_back(MENU *menu, chtype attr);
  60        chtype menu_back(const MENU *menu);
  61        int set_menu_grey(MENU *menu, chtype attr);
  62        chtype menu_grey(const MENU *menu);
  63        int set_menu_pad(MENU *menu, int pad);
  64        int menu_pad(const MENU *menu);
  65
  66
  67 </PRE>
  68 <H2>DESCRIPTION</H2><PRE>
  69        The  function  <STRONG>set_menu_fore</STRONG> sets the foreground attribute
  70        of <EM>menu</EM>. This is the  highlight  used  for  selected  menu
  71        items.   <STRONG>menu_fore</STRONG>  returns the foreground attribute.  The
  72        default is <STRONG>A_REVERSE</STRONG>.
  73
  74        The function <STRONG>set_menu_back</STRONG> sets the  background  attribute
  75        of  <EM>menu</EM>.  This  is the highlight used for selectable (but
  76        not  currently  selected)  menu   items.    The   function
  77        <STRONG>menu_back</STRONG>  returns  the background attribute.  The default
  78        is <STRONG>A_NORMAL</STRONG>.
  79
  80        The function <STRONG>set_menu_grey</STRONG>  sets  the  grey  attribute  of
  81        <EM>menu</EM>.  This  is  the highlight used for un-selectable menu
  82        items in menus that permit more than one  selection.   The
  83        function   <STRONG>menu_grey</STRONG>  returns  the  grey  attribute.   The
  84        default is <STRONG>A_UNDERLINE</STRONG>.
  85
  86        The function <STRONG>set_menu_pad</STRONG> sets the character used to  fill
  87        the space between the name and description parts of a menu
  88        item.  <STRONG>menu_pad</STRONG> returns the given  menu's  pad  character.
  89        The default is a blank.
  90
  91
  92 </PRE>
  93 <H2>RETURN VALUE</H2><PRE>
  94        These routines return one of the following:
  95
  96        <STRONG>E_OK</STRONG> The routine succeeded.
  97
  98        <STRONG>E_SYSTEM_ERROR</STRONG>
  99             System error occurred (see <STRONG>errno</STRONG>).
 100
 101        <STRONG>E_BAD_ARGUMENT</STRONG>
 102             Routine  detected  an incorrect or out-of-range argu-
 103             ment.
 104
 105
 106 </PRE>
 107 <H2>SEE ALSO</H2><PRE>
 108        <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG> and related pages whose names begin "menu_" for
 109        detailed descriptions of the entry points.
 110
 111
 112 </PRE>
 113 <H2>NOTES</H2><PRE>
 114        The header file <STRONG>&lt;menu.h&gt;</STRONG> automatically includes the header
 115        file <STRONG>&lt;curses.h&gt;</STRONG>.
 116
 117
 118 </PRE>
 119 <H2>PORTABILITY</H2><PRE>
 120        These routines emulate the System V  menu  library.   They
 121        were not supported on Version 7 or BSD versions.
 122
 123
 124 </PRE>
 125 <H2>AUTHORS</H2><PRE>
 126        Juergen  Pfeifer.   Manual  pages  and  adaptation for new
 127        curses by Eric S. Raymond.
 128
 129
 130
 131                                                     <STRONG><A HREF="menu_attributes.3x.html">menu_attributes(3x)</A></STRONG>
 132 </PRE>
 133 <HR>
 134 <ADDRESS>
 135 Man(1) output converted with
 136 <a href="http://www.oac.uci.edu/indiv/ehood/man2html.html">man2html</a>
 137 </ADDRESS>
 138 </BODY>
 139 </HTML>