| 1 | '\" t
|
|---|
| 2 | .\"***************************************************************************
|
|---|
| 3 | .\" Copyright (c) 1998 Free Software Foundation, Inc. *
|
|---|
| 4 | .\" *
|
|---|
| 5 | .\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|---|
| 6 | .\" copy of this software and associated documentation files (the *
|
|---|
| 7 | .\" "Software"), to deal in the Software without restriction, including *
|
|---|
| 8 | .\" without limitation the rights to use, copy, modify, merge, publish, *
|
|---|
| 9 | .\" distribute, distribute with modifications, sublicense, and/or sell *
|
|---|
| 10 | .\" copies of the Software, and to permit persons to whom the Software is *
|
|---|
| 11 | .\" furnished to do so, subject to the following conditions: *
|
|---|
| 12 | .\" *
|
|---|
| 13 | .\" The above copyright notice and this permission notice shall be included *
|
|---|
| 14 | .\" in all copies or substantial portions of the Software. *
|
|---|
| 15 | .\" *
|
|---|
| 16 | .\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|---|
| 17 | .\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|---|
| 18 | .\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|---|
| 19 | .\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|---|
| 20 | .\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|---|
| 21 | .\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|---|
| 22 | .\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|---|
| 23 | .\" *
|
|---|
| 24 | .\" Except as contained in this notice, the name(s) of the above copyright *
|
|---|
| 25 | .\" holders shall not be used in advertising or otherwise to promote the *
|
|---|
| 26 | .\" sale, use or other dealings in this Software without prior written *
|
|---|
| 27 | .\" authorization. *
|
|---|
| 28 | .\"***************************************************************************
|
|---|
| 29 | .\"
|
|---|
| 30 | .\" $Id: menu_win.3x,v 1.6 1998/11/29 01:11:11 Rick.Ohnemus Exp $
|
|---|
| 31 | .TH menu_win 3X ""
|
|---|
| 32 | .SH NAME
|
|---|
| 33 | \fBmenu_win\fR - make and break menu window and subwindow associations
|
|---|
| 34 | .SH SYNOPSIS
|
|---|
| 35 | \fB#include <menu.h>\fR
|
|---|
| 36 | .br
|
|---|
| 37 | int set_menu_win(MENU *menu, WINDOW *win);
|
|---|
| 38 | .br
|
|---|
| 39 | WINDOW *menu_win(const MENU *menu);
|
|---|
| 40 | .br
|
|---|
| 41 | int set_menu_sub(MENU *menu, WINDOW *sub);
|
|---|
| 42 | .br
|
|---|
| 43 | WINDOW *menu_sub(const MENU *menu);
|
|---|
| 44 | .br
|
|---|
| 45 | int scale_menu(const MENU *menu, int *rows, int *columns);
|
|---|
| 46 | .br
|
|---|
| 47 | .SH DESCRIPTION
|
|---|
| 48 | Every menu has an associated pair of \fBcurses\fR windows. The menu window
|
|---|
| 49 | displays any title and border associated with the window; the menu subwindow
|
|---|
| 50 | displays the items of the menu that are currently available for selection.
|
|---|
| 51 |
|
|---|
| 52 | The first four functions get and set those windows. It is not necessary to set
|
|---|
| 53 | either window; by default, the driver code uses \fBstdscr\fR for both.
|
|---|
| 54 |
|
|---|
| 55 | In the \fBset_\fR functions, window argument of \fBNULL\fR is treated as though
|
|---|
| 56 | it were \fBstsdcr\fR. A menu argument of \fBNULL\fR is treated as a request
|
|---|
| 57 | to change the system default menu window or subwindow.
|
|---|
| 58 |
|
|---|
| 59 | The function \fBscale_menu\fR returns the minimum size required for the
|
|---|
| 60 | subwindow of \fImenu\fR.
|
|---|
| 61 | .SH RETURN VALUE
|
|---|
| 62 | Routines that return pointers return \fBNULL\fR on error. Routines that return
|
|---|
| 63 | an integer return one of the following error codes:
|
|---|
| 64 | .TP 5
|
|---|
| 65 | \fBE_OK\fR
|
|---|
| 66 | The routine succeeded.
|
|---|
| 67 | .TP 5
|
|---|
| 68 | \fBE_SYSTEM_ERROR\fR
|
|---|
| 69 | System error occurred (see \fBerrno\fR).
|
|---|
| 70 | .TP 5
|
|---|
| 71 | \fBE_BAD_ARGUMENT\fR
|
|---|
| 72 | Routine detected an incorrect or out-of-range argument.
|
|---|
| 73 | .TP 5
|
|---|
| 74 | \fBE_POSTED\fR
|
|---|
| 75 | The menu has already been posted.
|
|---|
| 76 | .TP 5
|
|---|
| 77 | \fBE_NOT_CONNECTED\fR
|
|---|
| 78 | No items are connected to the menu.
|
|---|
| 79 | .SH SEE ALSO
|
|---|
| 80 | \fBcurses\fR(3X), \fBmenu\fR(3X).
|
|---|
| 81 | .SH NOTES
|
|---|
| 82 | The header file \fB<menu.h>\fR automatically includes the header file
|
|---|
| 83 | \fB<curses.h>\fR.
|
|---|
| 84 | .SH PORTABILITY
|
|---|
| 85 | These routines emulate the System V menu library. They were not supported on
|
|---|
| 86 | Version 7 or BSD versions.
|
|---|
| 87 | .SH AUTHORS
|
|---|
| 88 | Juergen Pfeifer. Manual pages and adaptation for new curses by Eric
|
|---|
| 89 | S. Raymond.
|
|---|
| 90 | .\"#
|
|---|
| 91 | .\"# The following sets edit modes for GNU EMACS
|
|---|
| 92 | .\"# Local Variables:
|
|---|
| 93 | .\"# mode:nroff
|
|---|
| 94 | .\"# fill-column:79
|
|---|
| 95 | .\"# End:
|
|---|
