X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_spacing.3x;h=7d67f0b6aa2fbebd61053ff48e3a3f6bc6632a07;hp=0332e47f56b36507a77615f152da17d6f08c2b48;hb=152c5a605234b7ea36ba3a03ec07e124bb6aac75;hpb=41068edef084c39be0cecdf949d9b538d925f42c diff --git a/man/menu_spacing.3x b/man/menu_spacing.3x index 0332e47f..7d67f0b6 100644 --- a/man/menu_spacing.3x +++ b/man/menu_spacing.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2004,2010 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,40 +28,43 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_spacing.3x,v 1.9 2010/01/30 21:29:04 tom Exp $ +.\" $Id: menu_spacing.3x,v 1.17 2020/10/17 23:48:53 tom Exp $ .TH menu_spacing 3X "" .SH NAME -\fBmenu_spacing\fR - Control spacing between menu items. +\fBset_menu_spacing\fP, +\fBmenu_spacing\fR \- set and get spacing between menu items. .SH SYNOPSIS \fB#include \fR +.sp +\fBint set_menu_spacing(MENU *\fP\fImenu\fP\fB,\fP + \fBint \fP\fIspc_description\fP\fB,\fP + \fBint \fP\fIspc_rows\fP\fB,\fP + \fBint \fP\fIspc_columns\fP\fB);\fP .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); +\fBint menu_spacing(const MENU *\fP\fImenu\fP\fB,\fP + \fBint* \fP\fIspc_description\fP\fB,\fP + \fBint* \fP\fIspc_rows\fP\fB,\fP + \fBint* \fP\fIspc_columns\fP\fB);\fP .br .SH DESCRIPTION -The function \fBset_menu_spacing\fR sets the spacing informations for the menu. -Its parameter \fBspc_description\fR controls the number of spaces between an item name and an item -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. +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. +The \fBspc_columns\fR parameter controls +the number of blanks between columns of items. +It must not be larger than \fBTABSIZE\fP. +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 @@ -71,7 +75,9 @@ Both routines return \fBE_OK\fR on success. \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), \fBmenu\fR(3X). +\fBcurses\fR(3X), +\fBcurs_variables\fR(3X), +\fBmenu\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. @@ -84,9 +90,3 @@ 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. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: