X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_spacing.3x;h=696833e990125d947443d4ce22eed97a31731770;hp=0480b3c02d4b063f46893eb69a5745f1d93eff82;hb=5c2245b6fc619f8d96ce940281dfbf13b5b8900b;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce;ds=inline diff --git a/man/menu_spacing.3x b/man/menu_spacing.3x index 0480b3c0..696833e9 100644 --- a/man/menu_spacing.3x +++ b/man/menu_spacing.3x @@ -1,6 +1,6 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright (c) 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,58 +27,63 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_spacing.3x,v 1.5 1998/11/29 01:10:51 Rick.Ohnemus Exp $ +.\" $Id: menu_spacing.3x,v 1.13 2015/12/05 23:42:45 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 .br int set_menu_spacing(MENU *menu, - int spc_description + int spc_description, int spc_rows, int spc_columns); .br int menu_spacing(const MENU *menu, - int* spc_description + int* spc_description, int* spc_rows, int* spc_columns); .br .SH DESCRIPTION -The function \fBset_menu_spacing\fR sets the spacing informations for the menu. -\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 +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. -\fBspc_rows\fR controls the number of rows that are used for an item. It must not be -larger than 3. The menu system inserts then blank lines between item rows, these lines +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. -\fBspc_columns\fR controls the number of blanks between columns of items. It must not -be larger than TABSIZE. +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 +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 +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), \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. .SH PORTABILITY -These routines are specific to ncurses. They were not supported on -Version 7, BSD or System V implementations. It is recommended that +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. -.\"# -.\"# 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.