Seth Woolley's Man Viewer

menu_win(3X)                                                      menu_win(3X)



NAME
       menu_win - make and break menu(3x,n,n tk_menuSetFocus) window and subwindow associations

SYNOPSIS
       #include <menu.h>
       int set_menu_win(MENU *menu(3x,n,n tk_menuSetFocus), WINDOW *win);
       WINDOW *menu_win(const MENU *menu(3x,n,n tk_menuSetFocus));
       int set_menu_sub(MENU *menu(3x,n,n tk_menuSetFocus), WINDOW *sub);
       WINDOW *menu_sub(const MENU *menu(3x,n,n tk_menuSetFocus));
       int scale_menu(const MENU *menu(3x,n,n tk_menuSetFocus), int *rows, int *columns);

DESCRIPTION
       Every  menu(3x,n,n tk_menuSetFocus)  has an associated pair of curses windows.  The menu(3x,n,n tk_menuSetFocus) window
       displays any title and border associated with the window; the menu(3x,n,n tk_menuSetFocus) sub-
       window  displays the items of the menu(3x,n,n tk_menuSetFocus) that are currently available for
       selection.

       The first four functions get and set(7,n,1 builtins) those windows.  It is  not  neces-
       sary  to set(7,n,1 builtins) 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(3x,n,n tk_menuSetFocus) argument of NULL is treated as a request to change
       the system default menu(3x,n,n tk_menuSetFocus) window or subwindow.

       The function scale_menu returns the minimum size required for the  sub-
       window of menu(3x,n,n tk_menuSetFocus).

RETURN VALUE
       Routines  that  return  pointers  return  NULL on error.  Routines that
       return an integer return one of the following error(8,n) codes:

       E_OK The routine succeeded.

       E_SYSTEM_ERROR
            System error(8,n) occurred (see errno).

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

       E_POSTED
            The menu(3x,n,n tk_menuSetFocus) has already been posted.

       E_NOT_CONNECTED
            No items are connected to the menu.

SEE ALSO
       curses(3X), menu(3x,n,n tk_menuSetFocus)(3X).

NOTES
       The  header  file(1,n)  <menu.h>  automatically  includes  the  header  file(1,n)
       <curses.h>.

PORTABILITY
       These  routines  emulate the System V menu(3x,n,n tk_menuSetFocus) library.  They were not sup-
       ported on Version 7 or BSD versions.

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



                                                                  menu_win(3X)