| 1 | '\" t
|
|---|
| 2 | .\"***************************************************************************
|
|---|
| 3 | .\" Copyright (c) 1998-2004,2010 Free Software Foundation, Inc. *
|
|---|
| 4 | .\" *
|
|---|
| 5 | .\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|---|
| 6 | .\" copy of this software and associated documentation files (the *
|
|---|
| 7 | .\" "Software"), to deal in the Software without restriction, including *
|
|---|
| 8 | .\" without limitation the rights to use, copy, modify, merge, publish, *
|
|---|
| 9 | .\" distribute, distribute with modifications, sublicense, and/or sell *
|
|---|
| 10 | .\" copies of the Software, and to permit persons to whom the Software is *
|
|---|
| 11 | .\" furnished to do so, subject to the following conditions: *
|
|---|
| 12 | .\" *
|
|---|
| 13 | .\" The above copyright notice and this permission notice shall be included *
|
|---|
| 14 | .\" in all copies or substantial portions of the Software. *
|
|---|
| 15 | .\" *
|
|---|
| 16 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|---|
| 17 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|---|
| 18 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|---|
| 19 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|---|
| 20 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|---|
| 21 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|---|
| 22 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|---|
| 23 | .\" *
|
|---|
| 24 | .\" Except as contained in this notice, the name(s) of the above copyright *
|
|---|
| 25 | .\" holders shall not be used in advertising or otherwise to promote the *
|
|---|
| 26 | .\" sale, use or other dealings in this Software without prior written *
|
|---|
| 27 | .\" authorization. *
|
|---|
| 28 | .\"***************************************************************************
|
|---|
| 29 | .\"
|
|---|
| 30 | .\" $Id: menu_spacing.3x,v 1.12 2010/12/04 18:38:55 tom Exp $
|
|---|
| 31 | .TH menu_spacing 3X ""
|
|---|
| 32 | .SH NAME
|
|---|
| 33 | \fBmenu_spacing\fR \- Control spacing between menu items.
|
|---|
| 34 | .SH SYNOPSIS
|
|---|
| 35 | \fB#include <menu.h>\fR
|
|---|
| 36 | .br
|
|---|
| 37 | int set_menu_spacing(MENU *menu,
|
|---|
| 38 | int spc_description,
|
|---|
| 39 | int spc_rows,
|
|---|
| 40 | int spc_columns);
|
|---|
| 41 | .br
|
|---|
| 42 | int menu_spacing(const MENU *menu,
|
|---|
| 43 | int* spc_description,
|
|---|
| 44 | int* spc_rows,
|
|---|
| 45 | int* spc_columns);
|
|---|
| 46 | .br
|
|---|
| 47 | .SH DESCRIPTION
|
|---|
| 48 | The function \fBset_menu_spacing\fR sets the spacing information for the menu.
|
|---|
| 49 | Its parameter \fBspc_description\fR controls the number of spaces between an item name and an item
|
|---|
| 50 | description.
|
|---|
| 51 | It must not be larger than \fBTABSIZE\fR.
|
|---|
| 52 | The menu system puts in the
|
|---|
| 53 | middle of this spacing area the pad character.
|
|---|
| 54 | The remaining parts are filled with
|
|---|
| 55 | spaces.
|
|---|
| 56 | The \fBspc_rows\fR parameter controls the number of rows that are used for an item.
|
|---|
| 57 | It must not be larger than 3.
|
|---|
| 58 | The menu system inserts the blank lines between item rows, these lines
|
|---|
| 59 | will contain the pad character in the appropriate positions.
|
|---|
| 60 | The \fBspc_columns\fR parameter controls the number of blanks between columns of items.
|
|---|
| 61 | It must not be larger than TABSIZE.
|
|---|
| 62 | A value of 0 for all the spacing values resets them to the default, which is 1 for all
|
|---|
| 63 | of them.
|
|---|
| 64 | .br
|
|---|
| 65 | The function \fBmenu_spacing\fR passes back the spacing info for the menu.
|
|---|
| 66 | If a
|
|---|
| 67 | pointer is NULL, this specific info is simply not returned.
|
|---|
| 68 | .SH RETURN VALUE
|
|---|
| 69 | Both routines return \fBE_OK\fR on success.
|
|---|
| 70 | \fBset_menu_spacing\fR may return
|
|---|
| 71 | \fBE_POSTED\fR if the menu is posted, or \fBE_BAD_ARGUMENT\fR if one of the
|
|---|
| 72 | spacing values is out of range.
|
|---|
| 73 | .SH SEE ALSO
|
|---|
| 74 | \fBcurses\fR(3X),
|
|---|
| 75 | \fBcurs_variables\fR(3X),
|
|---|
| 76 | \fBmenu\fR(3X).
|
|---|
| 77 | .SH NOTES
|
|---|
| 78 | The header file \fB<menu.h>\fR automatically includes the header file
|
|---|
| 79 | \fB<curses.h>\fR.
|
|---|
| 80 | .SH PORTABILITY
|
|---|
| 81 | These routines are specific to ncurses.
|
|---|
| 82 | They were not supported on
|
|---|
| 83 | Version 7, BSD or System V implementations.
|
|---|
| 84 | It is recommended that
|
|---|
| 85 | any code depending on them be conditioned using NCURSES_VERSION.
|
|---|
| 86 | .SH AUTHORS
|
|---|
| 87 | Juergen Pfeifer.
|
|---|
| 88 | Manual pages and adaptation for new curses by Eric S. Raymond.
|
|---|
