diff options
Diffstat (limited to 'ncurses-5.9/man/menu_spacing.3x')
-rw-r--r-- | ncurses-5.9/man/menu_spacing.3x | 88 |
1 files changed, 88 insertions, 0 deletions
diff --git a/ncurses-5.9/man/menu_spacing.3x b/ncurses-5.9/man/menu_spacing.3x new file mode 100644 index 0000000..611bc09 --- /dev/null +++ b/ncurses-5.9/man/menu_spacing.3x @@ -0,0 +1,88 @@ +'\" t +.\"*************************************************************************** +.\" Copyright (c) 1998-2004,2010 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 * +.\" "Software"), to deal in the Software without restriction, including * +.\" without limitation the rights to use, copy, modify, merge, publish, * +.\" distribute, distribute with modifications, sublicense, and/or sell * +.\" copies of the Software, and to permit persons to whom the Software is * +.\" furnished to do so, subject to the following conditions: * +.\" * +.\" The above copyright notice and this permission notice shall be included * +.\" in all copies or substantial portions of the Software. * +.\" * +.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS * +.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF * +.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. * +.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, * +.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR * +.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR * +.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. * +.\" * +.\" Except as contained in this notice, the name(s) of the above copyright * +.\" holders shall not be used in advertising or otherwise to promote the * +.\" sale, use or other dealings in this Software without prior written * +.\" authorization. * +.\"*************************************************************************** +.\" +.\" $Id$ +.TH menu_spacing 3X "" +.SH NAME +\fBmenu_spacing\fR \- Control spacing between menu items. +.SH SYNOPSIS +\fB#include <menu.h>\fR +.br +int set_menu_spacing(MENU *menu, + int spc_description, + int spc_rows, + int spc_columns); +.br +int menu_spacing(const MENU *menu, + int* spc_description, + int* spc_rows, + int* spc_columns); +.br +.SH DESCRIPTION +The function \fBset_menu_spacing\fR sets the spacing information for the menu. +Its parameter \fBspc_description\fR controls the number of spaces between an item name and an item +description. +It must not be larger than \fBTABSIZE\fR. +The menu system puts in the +middle of this spacing area the pad character. +The remaining parts are filled with +spaces. +The \fBspc_rows\fR parameter controls the number of rows that are used for an item. +It must not be larger than 3. +The menu system inserts the blank lines between item rows, these lines +will contain the pad character in the appropriate positions. +The \fBspc_columns\fR parameter controls the number of blanks between columns of items. +It must not be larger than TABSIZE. +A value of 0 for all the spacing values resets them to the default, which is 1 for all +of them. +.br +The function \fBmenu_spacing\fR passes back the spacing info for the menu. +If a +pointer is NULL, this specific info is simply not returned. +.SH RETURN VALUE +Both routines return \fBE_OK\fR on success. +\fBset_menu_spacing\fR may return +\fBE_POSTED\fR if the menu is posted, or \fBE_BAD_ARGUMENT\fR if one of the +spacing values is out of range. +.SH SEE ALSO +\fBcurses\fR(3X), +\fBcurs_variables\fR(3X), +\fBmenu\fR(3X). +.SH NOTES +The header file \fB<menu.h>\fR automatically includes the header file +\fB<curses.h>\fR. +.SH PORTABILITY +These routines are specific to ncurses. +They were not supported on +Version 7, BSD or System V implementations. +It is recommended that +any code depending on them be conditioned using NCURSES_VERSION. +.SH AUTHORS +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond. |