X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_attributes.3x;h=903e303c8dac2de30b822c6ec007c6104fc11afe;hp=99a2ac2bc1012e3657232fca9977659a4d706d5a;hb=5925150381bb42a4d8c7116d62c348a7b84309f3;hpb=46722468f47c2b77b3987729b4bcf2321cccfd01 diff --git a/man/menu_attributes.3x b/man/menu_attributes.3x index 99a2ac2b..903e303c 100644 --- a/man/menu_attributes.3x +++ b/man/menu_attributes.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998,2002 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 Thomas E. Dickey * +.\" Copyright 1998-2010,2015 Free Software Foundation, Inc. * .\" * .\" Permission is hereby granted, free of charge, to any person obtaining a * .\" copy of this software and associated documentation files (the * @@ -27,74 +28,86 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_attributes.3x,v 1.7 2002/01/19 22:49:06 tom Exp $ +.\" $Id: menu_attributes.3x,v 1.19 2020/10/17 23:58:58 tom Exp $ .TH menu_attributes 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .SH NAME -\fBmenu_attributes\fR - color and attribute control for menus +\fBmenu_back\fR, +\fBmenu_fore\fR, +\fBmenu_grey\fR, +\fBmenu_pad\fR, +\fBset_menu_back\fR, +\fBset_menu_fore\fR, +\fBset_menu_grey\fR, +\fBset_menu_pad\fR \- color and attribute control for menus .SH SYNOPSIS \fB#include \fR +.sp +\fBint set_menu_fore(MENU *\fP\fImenu\fP\fB, chtype \fP\fIattr\fP\fB);\fP .br -int set_menu_fore(MENU *menu, chtype attr); +\fBchtype menu_fore(const MENU *\fP\fImenu\fP\fB);\fP +.sp +\fBint set_menu_back(MENU *\fP\fImenu\fP\fB, chtype \fP\fIattr\fP\fB);\fP .br -chtype menu_fore(const MENU *menu); +\fBchtype menu_back(const MENU *\fP\fImenu\fP\fB);\fP +.sp +\fBint set_menu_grey(MENU *\fP\fImenu\fP\fB, chtype \fP\fIattr\fP\fB);\fP .br -int set_menu_back(MENU *menu, chtype attr); +\fBchtype menu_grey(const MENU *\fP\fImenu\fP\fB);\fP +.sp +\fBint set_menu_pad(MENU *\fP\fImenu\fP\fB, int \fP\fIpad\fP\fB);\fP .br -chtype menu_back(const MENU *menu); -.br -int set_menu_grey(MENU *menu, chtype attr); -.br -chtype menu_grey(const MENU *menu); -.br -int set_menu_pad(MENU *menu, int pad); -.br -int menu_pad(const MENU *menu); +\fBint menu_pad(const MENU *\fP\fImenu\fP\fB);\fP .br .SH DESCRIPTION The function \fBset_menu_fore\fR sets the foreground attribute of \fImenu\fR. This is the highlight used for selected menu items. -\fBmenu_fore\fR returns the foreground attribute. The default -is \fBA_STANDOUT\fR. - +\fBmenu_fore\fR returns the foreground attribute. +The default +is \fBA_REVERSE\fR. +.PP The function \fBset_menu_back\fR sets the background attribute of \fImenu\fR. This is the highlight used for selectable (but not currently -selected) menu items. The function \fBmenu_back\fR returns the background -attribute. The default is \fBA_NORMAL\fR. - +selected) menu items. +The function \fBmenu_back\fR returns the background +attribute. +The default is \fBA_NORMAL\fR. +.PP The function \fBset_menu_grey\fR sets the grey attribute of \fImenu\fR. This is the highlight used for un-selectable menu items in menus that permit more than -one selection. The function \fBmenu_grey\fR returns the grey attribute. +one selection. +The function \fBmenu_grey\fR returns the grey attribute. The default is \fBA_UNDERLINE\fR. - +.PP The function \fBset_menu_pad\fR sets the character used to fill the space -between the name and description parts of a menu item. \fBmenu_pad\fR returns -the given menu's pad character. The default is a blank. +between the name and description parts of a menu item. +\fBmenu_pad\fR returns +the given menu's pad character. +The default is a blank. .SH RETURN VALUE These routines return one of the following: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR(3)). .TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .SH SEE ALSO -\fBcurses\fR(3X) and related pages whose names begin "menu_" for detailed +\fBcurses\fR(3X) and related pages whose names begin \*(``menu_\*('' for detailed descriptions of the entry points. .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +These routines emulate the System V menu library. +They were not supported on Version 7 or BSD versions. .SH AUTHORS -Juergen Pfeifer. Manual pages and adaptation for new curses by Eric -S. Raymond. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.