\" $NetBSD: menu_format.3,v 1.10 2017/07/03 21:32:50 wiz Exp $

\" $NetBSD: menu_format.3,v 1.10 2017/07/03 21:32:50 wiz Exp $
\"
\" Copyright (c) 1999
\" Brett Lymn - [email protected], [email protected]
\"
\" This code is donated to The NetBSD Foundation by the author.
\"
\" Redistribution and use in source and binary forms, with or without
\" modification, are permitted provided that the following conditions
\" are met:
\" 1. Redistributions of source code must retain the above copyright
\" notice, this list of conditions and the following disclaimer.
\" 2. Redistributions in binary form must reproduce the above copyright
\" notice, this list of conditions and the following disclaimer in the
\" documentation and/or other materials provided with the distribution.
\" 3. The name of the Author may not be used to endorse or promote
\" products derived from this software without specific prior written
\" permission.
\"
\" THIS SOFTWARE IS PROVIDED BY THE AUTHOR ``AS IS'' AND
\" ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT LIMITED TO, THE
\" IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR A PARTICULAR PURPOSE
\" ARE DISCLAIMED. IN NO EVENT SHALL THE AUTHOR BE LIABLE
\" FOR ANY DIRECT, INDIRECT, INCIDENTAL, SPECIAL, EXEMPLARY, OR CONSEQUENTIAL
\" DAMAGES (INCLUDING, BUT NOT LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS
\" OR SERVICES; LOSS OF USE, DATA, OR PROFITS; OR BUSINESS INTERRUPTION)
\" HOWEVER CAUSED AND ON ANY THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT
\" LIABILITY, OR TORT (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY
\" OUT OF THE USE OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF
\" SUCH DAMAGE.
\"
Dd September 10, 1999
Dt MENU_FORMAT 3
Os
Sh NAME
Nm menu_format ,
Nm set_menu_format
Nd get or set number of rows and columns of items
Sh LIBRARY
Lb libmenu
Sh SYNOPSIS
In menu.h
Ft void
Fn menu_format "MENU *menu" "int *rows" "int *cols"
Ft int
Fn set_menu_format "MENU *menu" "int rows" "int cols"
Sh DESCRIPTION
The
Fn menu_format
returns the number of rows and columns of items that can be displayed
by the menu.
The format is set by the
Fn set_menu_format
function call.
Note that the rows and columns defined here are not the size of the
window but rather the number of rows and columns of items.
Sh RETURN VALUES
The functions return one of the following error values:
Pp
Bl -tag -width E_BAD_ARGUMENT -compact
It Er E_OK
The function was successful.
It Er E_BAD_ARGUMENT
One or more of the arguments passed to the function was incorrect.
It Er E_POSTED
The menu is already posted.
El
Sh SEE ALSO
Xr curses 3 ,
Xr menus 3
Sh NOTES
The header
Pa <menu.h>
automatically includes both
Pa <curses.h>
and
Pa <eti.h> .