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

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