lib/libncurses/man/menu_attributes.3x

   1 '\" t
   2 .\"***************************************************************************
   3 .\" Copyright (c) 1998-2010,2015 Free Software Foundation, Inc.              *
   4 .\"                                                                          *
   5 .\" Permission is hereby granted, free of charge, to any person obtaining a  *
   6 .\" copy of this software and associated documentation files (the            *
   7 .\" "Software"), to deal in the Software without restriction, including      *
   8 .\" without limitation the rights to use, copy, modify, merge, publish,      *
   9 .\" distribute, distribute with modifications, sublicense, and/or sell       *
  10 .\" copies of the Software, and to permit persons to whom the Software is    *
  11 .\" furnished to do so, subject to the following conditions:                 *
  12 .\"                                                                          *
  13 .\" The above copyright notice and this permission notice shall be included  *
  14 .\" in all copies or substantial portions of the Software.                   *
  15 .\"                                                                          *
  16 .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
  17 .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
  18 .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
  19 .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
  20 .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
  21 .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
  22 .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
  23 .\"                                                                          *
  24 .\" Except as contained in this notice, the name(s) of the above copyright   *
  25 .\" holders shall not be used in advertising or otherwise to promote the     *
  26 .\" sale, use or other dealings in this Software without prior written       *
  27 .\" authorization.                                                           *
  28 .\"***************************************************************************
  29 .\"
  30 .\" $Id: menu_attributes.3x,v 1.13 2015/12/05 20:44:42 jmc Exp $
  31 .TH menu_attributes 3X ""
  32 .SH NAME
  33 \fBmenu_back\fR,
  34 \fBmenu_fore\fR,
  35 \fBmenu_grey\fR,
  36 \fBmenu_pad\fR,
  37 \fBset_menu_back\fR,
  38 \fBset_menu_fore\fR,
  39 \fBset_menu_grey\fR,
  40 \fBset_menu_pad\fR \- color and attribute control for menus
  41 .SH SYNOPSIS
  42 \fB#include <menu.h>\fR
  43 .br
  44 int set_menu_fore(MENU *menu, chtype attr);
  45 .br
  46 chtype menu_fore(const MENU *menu);
  47 .br
  48 int set_menu_back(MENU *menu, chtype attr);
  49 .br
  50 chtype menu_back(const MENU *menu);
  51 .br
  52 int set_menu_grey(MENU *menu, chtype attr);
  53 .br
  54 chtype menu_grey(const MENU *menu);
  55 .br
  56 int set_menu_pad(MENU *menu, int pad);
  57 .br
  58 int menu_pad(const MENU *menu);
  59 .br
  60 .SH DESCRIPTION
  61 The function \fBset_menu_fore\fR sets the foreground attribute of
  62 \fImenu\fR. This is the highlight used for selected menu items.
  63 \fBmenu_fore\fR returns the foreground attribute.  The default
  64 is \fBA_REVERSE\fR.
  65 .PP
  66 The function \fBset_menu_back\fR sets the background attribute of
  67 \fImenu\fR. This is the highlight used for selectable (but not currently
  68 selected) menu items.  The function \fBmenu_back\fR returns the background
  69 attribute.  The default is \fBA_NORMAL\fR.
  70 .PP
  71 The function \fBset_menu_grey\fR sets the grey attribute of \fImenu\fR. This is
  72 the highlight used for un-selectable menu items in menus that permit more than
  73 one selection.  The function \fBmenu_grey\fR returns the grey attribute.
  74 The default is \fBA_UNDERLINE\fR.
  75 .PP
  76 The function \fBset_menu_pad\fR sets the character used to fill the space
  77 between the name and description parts of a menu item.  \fBmenu_pad\fR returns
  78 the given menu's pad character.  The default is a blank.
  79 .SH RETURN VALUE
  80 These routines return one of the following:
  81 .TP 5
  82 .B E_OK
  83 The routine succeeded.
  84 .TP 5
  85 .B E_SYSTEM_ERROR
  86 System error occurred (see \fBerrno\fR).
  87 .TP 5
  88 .B E_BAD_ARGUMENT
  89 Routine detected an incorrect or out-of-range argument.
  90 .SH SEE ALSO
  91 \fBcurses\fR(3X) and related pages whose names begin "menu_" for detailed
  92 descriptions of the entry points.
  93 .SH NOTES
  94 The header file \fB<menu.h>\fR automatically includes the header file
  95 \fB<curses.h>\fR.
  96 .SH PORTABILITY
  97 These routines emulate the System V menu library.  They were not supported on
  98 Version 7 or BSD versions.
  99 .SH AUTHORS
 100 Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric
 101 S. Raymond.