107 lines
3.6 KiB
Groff
107 lines
3.6 KiB
Groff
.\" $NetBSD: menu_win.3,v 1.3 2001/02/26 01:26:06 blymn Exp $
|
|
.\"
|
|
.\" Copyright (c) 1999
|
|
.\" Brett Lymn - blymn@baea.com.au, brett_lymn@yahoo.com.au
|
|
.\"
|
|
.\" 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, 1999
|
|
.Dt MENU_WIN 3
|
|
.Os BSD 4
|
|
.Sh NAME
|
|
.Nm menu_sub ,
|
|
.Nm menu_win ,
|
|
.Nm scale_window ,
|
|
.Nm set_menu_sub
|
|
.Nd menu library
|
|
.Sh LIBRARY
|
|
.Lb libmenu
|
|
.Sh SYNOPSIS
|
|
.Fd #include <menu.h>
|
|
.Ft WINDOW *
|
|
.Fn menu_sub "MENU *menu"
|
|
.Ft WINDOW *
|
|
.Fn menu_win "MENU *menu"
|
|
.Ft int
|
|
.Fn scale_window "MENU *menu" "int *rows" "int *cols"
|
|
.Ft int
|
|
.Fn set_menu_sub "MENU *menu" "WINDOW *sub"
|
|
.Ft int
|
|
.Fn set_menu_win "MENU *menu" "WINDOW *win"
|
|
.Sh DESCRIPTION
|
|
The
|
|
.Fn menu_sub
|
|
function returns a pointer to the window that will be used to post a
|
|
menu into, this pointer is set by the
|
|
.Fn set_menu_sub
|
|
function. The
|
|
.Fn menu_win
|
|
function returns a pointer to the window in which the menu subwindow
|
|
will be created when the menu is posted, this pointer is set by the
|
|
.Fn set_menu_win
|
|
function. The
|
|
.Fn scale_window
|
|
function calculates the minimum size a window needs to be to hold the
|
|
items for a given menu, the parameters rows and cols are set to the
|
|
required number of rows and columns respectively.
|
|
.Sh RETURN VALUES
|
|
The functions return one of the following error values:
|
|
.Pp
|
|
.ta 20
|
|
.nf
|
|
E_OK The function was successful
|
|
E_SYSTEM_ERROR There was a system error during the call.
|
|
E_BAD_ARGUMENT One or more of the arguments passed to the function
|
|
was incorrect.
|
|
E_POSTED The menu is already posted.
|
|
E_CONNECTED An item was already connected to a menu.
|
|
E_BAD_STATE The function was called from within an initialisation
|
|
or termination routine.
|
|
E_NO_ROOM The menu does not fit within the subwindow.
|
|
E_NOT_POSTED The menu is not posted
|
|
E_UNKNOWN_COMMAND The menu driver does not recognise the request
|
|
passed to it.
|
|
E_NO_MATCH The character search failed to find a match.
|
|
E_NOT_SELECTABLE The item could not be selected.
|
|
E_NOT_CONNECTED The item is not connected to a menu.
|
|
E_REQUEST_DENIED The menu driver could not process the request.
|
|
.fi
|
|
.ft 1
|
|
.br
|
|
.ne 8
|
|
.Sh SEE ALSO
|
|
.Xr curses 3 ,
|
|
.Xr menus 3
|
|
.Sh NOTES
|
|
The header
|
|
.Xr <menu.h>
|
|
automatically includes both
|
|
.Xr <curses.h>
|
|
and
|
|
.Xr <eti.h>
|
|
|