menu_format(3) [netbsd man page]

MENU_FORMAT(3)						   BSD Library Functions Manual 					    MENU_FORMAT(3)

NAME

     menu_format, set_menu_format -- get or set number of rows and columns of items

LIBRARY

     Curses Menu Library (libmenu, -lmenu)

SYNOPSIS

     #include <menu.h>

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

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

DESCRIPTION

     The menu_format() returns the number of rows and columns of items that can be displayed by the menu.  The format is set by the
     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.

RETURN VALUES

     The functions return one of the following error values:

     E_OK	     The function was successful.
     E_BAD_ARGUMENT  One or more of the arguments passed to the function was incorrect.
     E_POSTED	     The menu is already posted.

SEE ALSO

     curses(3), menus(3)

NOTES

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

BSD
								September 10, 1999							       BSD

menu_format(3X) 														   menu_format(3X)

NAME

       menu_format - set and get menu sizes

SYNOPSIS

       #include <menu.h>
       int set_menu_format(MENU *menu, int rows, int cols);
       void menu_format(const MENU *menu, int *rows, int *cols);

DESCRIPTION

       The  function  set_menu_format  sets  the maximum display size of the given menu.  If this size is too small to display all menu items, the
       menu will be made scrollable. If this size is larger than the menus subwindow and the subwindow is too small to	display  all  menu  items,
       post_menu() will fail.

       The  default format is 16 rows, 1 column.  Calling set_menu_format with a null menu pointer will change this default.  A zero row or column
       argument to set_menu_format is interpreted as a request not to change the current value.

       The function menu_format returns the maximum-size constraints for the given menu into the storage addressed by rows and cols.

RETURN VALUE

       These routines returns one of the following:

       E_OK The routine succeeded.

       E_SYSTEM_ERROR
	    System error occurred (see errno).

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

       E_POSTED
	    The menu is already posted.

       E_NOT_CONNECTED
	    No items are connected to the menu.

SEE ALSO

       curses(3X), menu(3X).

NOTES

       The header file <menu.h> automatically includes the header file <curses.h>.

PORTABILITY

       These routines emulate the System V menu library.  They were not supported on Version 7 or BSD versions.

AUTHORS

       Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S. Raymond.

																   menu_format(3X)