t
***************************************************************************
Copyright (c) 1998-2006,2010 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 *
"Software"), to deal in the Software without restriction, including *
without limitation the rights to use, copy, modify, merge, publish, *
distribute, distribute with modifications, sublicense, and/or sell *
copies of the Software, and to permit persons to whom the Software is *
furnished to do so, subject to the following conditions: *
*
The above copyright notice and this permission notice shall be included *
in all copies or substantial portions of the Software. *
*
THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
*
Except as contained in this notice, the name(s) of the above copyright *
holders shall not be used in advertising or otherwise to promote the *
sale, use or other dealings in this Software without prior written *
authorization. *
***************************************************************************

$Id: menu_win.3x,v 1.11 2010/12/04 18:38:55 tom Exp $
menu_win - make and break menu window and subwindow associations #include <menu.h>

int set_menu_win(MENU *menu, WINDOW *win);

WINDOW *menu_win(const MENU *menu);

int set_menu_sub(MENU *menu, WINDOW *sub);

WINDOW *menu_sub(const MENU *menu);

int scale_menu(const MENU *menu, int *rows, int *columns);

Every menu has an associated pair of curses windows. The menu window displays any title and border associated with the window; the menu subwindow displays the items of the menu that are currently available for selection.

The first four functions get and set those windows. It is not necessary to set either window; by default, the driver code uses stdscr for both.

In the set_ functions, window argument of NULL is treated as though it were stsdcr. A menu argument of NULL is treated as a request to change the system default menu window or subwindow.

The function scale_menu returns the minimum size required for the subwindow of menu.

Routines that return pointers return NULL on error. Routines that return an integer return one of the following error codes:

5 E_OK The routine succeeded.

5 E_SYSTEM_ERROR System error occurred (see errno).

5 E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument.

5 E_POSTED The menu has already been posted.

5 E_NOT_CONNECTED No items are connected to the menu.

curses(3X), curs_variables(3X), menu(3X). The header file <menu.h> automatically includes the header file <curses.h>. These routines emulate the System V menu library. They were not supported on Version 7 or BSD versions. Juergen Pfeifer. Manual pages and adaptation for new curses by Eric S. Raymond.