1997-05-15 12:00:00 +08:00
|
|
|
'\" t
|
|
|
|
|
.TH menu_format 3X ""
|
|
|
|
|
.SH NAME
|
|
|
|
|
\fBmenu_format\fR - set and get menu sizes
|
|
|
|
|
.SH SYNOPSIS
|
|
|
|
|
\fB#include <menu.h>\fR
|
|
|
|
|
.br
|
|
|
|
|
int set_menu_format(MENU *menu, int rows, int cols);
|
|
|
|
|
.br
|
|
|
|
|
int menu_format(const MENU *menu, int *rows, int *cols);
|
|
|
|
|
.br
|
|
|
|
|
.SH DESCRIPTION
|
|
|
|
|
The function \fBset_menu_format\fR sets the maximum display size of the given
|
1998-03-01 12:21:12 +08:00
|
|
|
menu. If this size is too small to display all menu items, the menu will be
|
|
|
|
|
made scrollable. If this size is larger than the menus subwindow and the
|
|
|
|
|
subwindow is too small to display all menu items, \fBpost_menu()\fR will fail.
|
1997-05-15 12:00:00 +08:00
|
|
|
|
|
|
|
|
The default format is 16 rows, 1 column. Calling \fBset_menu_format\fR with a
|
|
|
|
|
null menu pointer will change this default. A zero row or column argument to
|
|
|
|
|
\fBset_menu_format\fR is interpreted as a request not to change the current
|
|
|
|
|
value.
|
|
|
|
|
|
|
|
|
|
The function \fBmenu_format\fR returns the maximum-size constraints for the
|
|
|
|
|
given menu into the storage addressed by \fBrows\fR and \fBcols\fR.
|
|
|
|
|
.SH RETURN VALUE
|
|
|
|
|
These routines returns one of the following:
|
|
|
|
|
.TP 5
|
|
|
|
|
\fBE_OK\fR
|
|
|
|
|
The routine succeeded.
|
|
|
|
|
.TP 5
|
|
|
|
|
\fBE_SYSTEM_ERROR\fR
|
|
|
|
|
System error occurred (see \fBerrno\fR).
|
|
|
|
|
.TP 5
|
|
|
|
|
\fBE_BAD_ARGUMENT\fR
|
|
|
|
|
Routine detected an incorrect or out-of-range argument.
|
|
|
|
|
.TP 5
|
|
|
|
|
\fBE_POSTED\fR
|
|
|
|
|
The menu is already posted.
|
|
|
|
|
.SH SEE ALSO
|
|
|
|
|
\fBcurses\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 emulate the System V menu library. They were not supported on
|
|
|
|
|
Version 7 or BSD versions.
|
|
|
|
|
.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:
|
