xref: /illumos-gate/usr/src/man/man3curses/menu_format.3curses (revision bc1f688b4872ace323eaddbb1a6365d054e7bf56)
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_FORMAT 3CURSES "Dec 31, 1996"
NAME
menu_format, set_menu_format - set and get maximum numbers of rows and columns in menus
SYNOPSIS

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

int set_menu_format(MENU *menu, int rows, int cols);

void menu_format(MENU *menu, int *rows, int *cols);
DESCRIPTION

set_menu_format() sets the maximum number of rows and columns of items that may be displayed at one time on a menu. If the menu contains more items than can be displayed at once, the menu will be scrollable.

menu_format() returns the maximum number of rows and columns that may be displayed at one time on menu. rows and cols are pointers to the variables used to return these values.

RETURN VALUES

set_menu_format() returns 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.

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>.