mirror of
https://github.com/Aigor44/ncursesw-morphos.git
synced 2024-12-27 07:49:06 +08:00
17c5992a16
+ improve documentation regarding feature-test macros in curses.h + improve documentation regarding the virtual and physical screens. + formatting fixes for manpages, regenerate man-html documentation.
96 lines
4.0 KiB
Plaintext
96 lines
4.0 KiB
Plaintext
'\" t
|
|
.\"***************************************************************************
|
|
.\" Copyright (c) 1998-2010,2018 Free Software Foundation, Inc. *
|
|
.\" *
|
|
.\" Permission is hereby granted, free of charge, to any person obtaining a *
|
|
.\" copy of this software and associated documentation files (the *
|
|
.\" "Software"), to deal in the Software without restriction, including *
|
|
.\" without limitation the rights to use, copy, modify, merge, publish, *
|
|
.\" distribute, distribute with modifications, sublicense, and/or sell *
|
|
.\" copies of the Software, and to permit persons to whom the Software is *
|
|
.\" furnished to do so, subject to the following conditions: *
|
|
.\" *
|
|
.\" The above copyright notice and this permission notice shall be included *
|
|
.\" in all copies or substantial portions of the Software. *
|
|
.\" *
|
|
.\" THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *
|
|
.\" OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *
|
|
.\" MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *
|
|
.\" IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *
|
|
.\" DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *
|
|
.\" OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *
|
|
.\" THE USE OR OTHER DEALINGS IN THE SOFTWARE. *
|
|
.\" *
|
|
.\" Except as contained in this notice, the name(s) of the above copyright *
|
|
.\" holders shall not be used in advertising or otherwise to promote the *
|
|
.\" sale, use or other dealings in this Software without prior written *
|
|
.\" authorization. *
|
|
.\"***************************************************************************
|
|
.\"
|
|
.\" $Id: menu_win.3x,v 1.12 2018/07/28 21:34:06 tom Exp $
|
|
.TH menu_win 3X ""
|
|
.SH NAME
|
|
\fBmenu_win\fR \- make and break menu window and subwindow associations
|
|
.SH SYNOPSIS
|
|
\fB#include <menu.h>\fR
|
|
.br
|
|
int set_menu_win(MENU *menu, WINDOW *win);
|
|
.br
|
|
WINDOW *menu_win(const MENU *menu);
|
|
.br
|
|
int set_menu_sub(MENU *menu, WINDOW *sub);
|
|
.br
|
|
WINDOW *menu_sub(const MENU *menu);
|
|
.br
|
|
int scale_menu(const MENU *menu, int *rows, int *columns);
|
|
.br
|
|
.SH DESCRIPTION
|
|
Every menu has an associated pair of \fBcurses\fR windows.
|
|
The menu window
|
|
displays any title and border associated with the window; the menu subwindow
|
|
displays the items of the menu that are currently available for selection.
|
|
.PP
|
|
The first four functions get and set those windows.
|
|
It is not necessary to set
|
|
either window; by default, the driver code uses \fBstdscr\fR for both.
|
|
.PP
|
|
In the \fBset_\fR functions, window argument of \fBNULL\fR is treated as though
|
|
it were \fBstsdcr\fR. A menu argument of \fBNULL\fR is treated as a request
|
|
to change the system default menu window or subwindow.
|
|
.PP
|
|
The function \fBscale_menu\fR returns the minimum size required for the
|
|
subwindow of \fImenu\fR.
|
|
.SH RETURN VALUE
|
|
Routines that return pointers return \fBNULL\fR on error.
|
|
Routines that return
|
|
an integer return one of the following error codes:
|
|
.TP 5
|
|
.B E_OK
|
|
The routine succeeded.
|
|
.TP 5
|
|
.B E_SYSTEM_ERROR
|
|
System error occurred (see \fBerrno\fR).
|
|
.TP 5
|
|
.B E_BAD_ARGUMENT
|
|
Routine detected an incorrect or out-of-range argument.
|
|
.TP 5
|
|
.B E_POSTED
|
|
The menu has already been posted.
|
|
.TP 5
|
|
.B E_NOT_CONNECTED
|
|
No items are connected to the menu.
|
|
.SH SEE ALSO
|
|
\fBcurses\fR(3X),
|
|
\fBcurs_variables\fR(3X),
|
|
\fBmenu\fR(3X).
|
|
.SH NOTES
|
|
The header file \fB<menu.h>\fR automatically includes the header file
|
|
\fB<curses.h>\fR.
|
|
.SH PORTABILITY
|
|
These routines emulate the System V menu library.
|
|
They were not supported on
|
|
Version 7 or BSD versions.
|
|
.SH AUTHORS
|
|
Juergen Pfeifer.
|
|
Manual pages and adaptation for new curses by Eric S. Raymond.
|