← Back to branch summary

~ubuntu-branches/ubuntu/natty/ncurses/natty

« back to all changes in this revision

Viewing changes to man/menu_attributes.3x

  • Committer: Bazaar Package Importer
  • Author(s): Matthias Klose
  • Date: 2007-05-17 09:00:42 UTC
  • mfrom: (1.1.3 upstream)
  • Revision ID: james.westby@ubuntu.com-20070517090042-86fgxrr6j5jzagot
Tags: 5.6-0ubuntu1
* New upstream version.
  - Remove patches applied upstream: ncurses.upstream, signed-chars.
  - Update patches: debian-backspace.
* Build-depend on g++-multilib instead of lib{32,64}c*-dev-*.

Show diffs side-by-side

added added

removed removed

Lines of Context:
man/menu_attributes.3x
1
1
'\" t
2
2
.\"***************************************************************************
3
 
.\" Copyright (c) 1998,2002 Free Software Foundation, Inc.                   *
 
3
.\" Copyright (c) 1998-2002,2006 Free Software Foundation, Inc.              *
4
4
.\"                                                                          *
5
5
.\" Permission is hereby granted, free of charge, to any person obtaining a  *
6
6
.\" copy of this software and associated documentation files (the            *
27
27
.\" authorization.                                                           *
28
28
.\"***************************************************************************
29
29
.\"
30
 
.\" $Id: menu_attributes.3x,v 1.7 2002/01/19 22:49:06 tom Exp $
 
30
.\" $Id: menu_attributes.3x,v 1.9 2006/11/04 17:12:00 tom Exp $
31
31
.TH menu_attributes 3X ""
32
32
.SH NAME
33
33
\fBmenu_attributes\fR - color and attribute control for menus
55
55
\fImenu\fR. This is the highlight used for selected menu items.
56
56
\fBmenu_fore\fR returns the foreground attribute.  The default
57
57
is \fBA_STANDOUT\fR.
58
 
 
 
58
.PP
59
59
The function \fBset_menu_back\fR sets the background attribute of
60
60
\fImenu\fR. This is the highlight used for selectable (but not currently
61
61
selected) menu items.  The function \fBmenu_back\fR returns the background
62
62
attribute.  The default is \fBA_NORMAL\fR.
63
 
 
 
63
.PP
64
64
The function \fBset_menu_grey\fR sets the grey attribute of \fImenu\fR. This is
65
65
the highlight used for un-selectable menu items in menus that permit more than
66
66
one selection.  The function \fBmenu_grey\fR returns the grey attribute.
67
67
The default is \fBA_UNDERLINE\fR.
68
 
 
 
68
.PP
69
69
The function \fBset_menu_pad\fR sets the character used to fill the space
70
70
between the name and description parts of a menu item.  \fBmenu_pad\fR returns
71
71
the given menu's pad character.  The default is a blank.
72
72
.SH RETURN VALUE
73
73
These routines return one of the following:
74
74
.TP 5
75
 
\fBE_OK\fR
 
75
.B E_OK
76
76
The routine succeeded.
77
77
.TP 5
78
 
\fBE_SYSTEM_ERROR\fR
 
78
.B E_SYSTEM_ERROR
79
79
System error occurred (see \fBerrno\fR).
80
80
.TP 5
81
 
\fBE_BAD_ARGUMENT\fR
 
81
.B E_BAD_ARGUMENT
82
82
Routine detected an incorrect or out-of-range argument.
83
83
.SH SEE ALSO
84
84
\fBcurses\fR(3X) and related pages whose names begin "menu_" for detailed