xref: /illumos-gate/usr/src/man/man3curses/menu_win.3curses (revision 78a2e113edb6fe0a0382b403b55d92e8f0bba78f)
te
Copyright 1989 AT&T
Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved.
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
MENU_WIN 3CURSES "Dec 31, 1996"
NAME
menu_win, set_menu_win, set_menu_sub, menu_sub, scale_menu - menus window and subwindow association routines
SYNOPSIS

cc [ flag... ] file... -lmenu  -lcurses  [ library... ]
#include <menu.h>

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

WINDOW *menu_win(MENU *menu);

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

WINDOW *menu_sub(MENU *menu);

int scale_window(MENU *menu, int *rows, int *cols);
DESCRIPTION

set_menu_win() sets the window of menu to win. menu_win() returns a pointer to the window of menu.set_menu_sub() sets the subwindow of menu to sub. menu_sub() returns a pointer to the subwindow of menu.scale_window() returns the minimum window size necessary for the subwindow of menu. rows and cols are pointers to the locations used to return the values.

RETURN VALUES

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

The routine returned successfully.

E_SYSTEM_ERROR

System error.

E_BAD_ARGUMENT

An incorrect argument was passed to the routine.

E_POSTED

The menu is already posted.

E_NOT_CONNECTED

No items are connected to the menu.

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
MT-Level Unsafe
SEE ALSO

curses(3CURSES), menus(3CURSES), attributes(5)

NOTES

The header <menu.h> automatically includes the headers <eti.h> and <curses.h>.