X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_attributes.3x;h=693096960942c339af62db4115b9a9888187fea4;hp=839de287ee0d270e5bd24544e4044ea009672a9b;hb=95b3f94ec8b2da797e3e9a18fb49320daa5ab221;hpb=eccca377f55c70b12e3e92621d94d1e1c1fcfb7d diff --git a/man/menu_attributes.3x b/man/menu_attributes.3x index 839de287..69309696 100644 --- a/man/menu_attributes.3x +++ b/man/menu_attributes.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2018,2019 Free Software Foundation, Inc. * +.\" Copyright 2018-2020,2021 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,59 +28,63 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_attributes.3x,v 1.15 2019/01/20 20:32:23 tom Exp $ +.\" $Id: menu_attributes.3x,v 1.21 2021/12/25 21:49:32 tom Exp $ .TH menu_attributes 3X "" +.ie \n(.g .ds `` \(lq +.el .ds `` `` +.ie \n(.g .ds '' \(rq +.el .ds '' '' .SH NAME -\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 +\fBmenu_back\fP, +\fBmenu_fore\fP, +\fBmenu_grey\fP, +\fBmenu_pad\fP, +\fBset_menu_back\fP, +\fBset_menu_fore\fP, +\fBset_menu_grey\fP, +\fBset_menu_pad\fP \- color and attribute control for menus .SH SYNOPSIS -\fB#include \fR +\fB#include \fP +.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 function \fBset_menu_fore\fP sets the foreground attribute of +\fImenu\fP. This is the highlight used for selected menu items. +\fBmenu_fore\fP returns the foreground attribute. The default -is \fBA_REVERSE\fR. +is \fBA_REVERSE\fP. .PP -The function \fBset_menu_back\fR sets the background attribute of -\fImenu\fR. This is the highlight used for selectable (but not currently +The function \fBset_menu_back\fP sets the background attribute of +\fImenu\fP. This is the highlight used for selectable (but not currently selected) menu items. -The function \fBmenu_back\fR returns the background +The function \fBmenu_back\fP returns the background attribute. -The default is \fBA_NORMAL\fR. +The default is \fBA_NORMAL\fP. .PP -The function \fBset_menu_grey\fR sets the grey attribute of \fImenu\fR. This is +The function \fBset_menu_grey\fP sets the grey attribute of \fImenu\fP. 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. -The default is \fBA_UNDERLINE\fR. +The function \fBmenu_grey\fP returns the grey attribute. +The default is \fBA_UNDERLINE\fP. .PP -The function \fBset_menu_pad\fR sets the character used to fill the space +The function \fBset_menu_pad\fP sets the character used to fill the space between the name and description parts of a menu item. -\fBmenu_pad\fR returns +\fBmenu_pad\fP returns the given menu's pad character. The default is a blank. .SH RETURN VALUE @@ -89,16 +94,16 @@ These routines return one of the following: The routine succeeded. .TP 5 .B E_SYSTEM_ERROR -System error occurred (see \fBerrno\fR(3)). +System error occurred (see \fBerrno\fP(3)). .TP 5 .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\fP(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. +The header file \fB\fP automatically includes the header file +\fB\fP. .SH PORTABILITY These routines emulate the System V menu library. They were not supported on