diff options
| author | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:54:44 -0400 |
|---|---|---|
| committer | Jacob McDonnell <jacob@jacobmcdonnell.com> | 2026-04-25 19:54:44 -0400 |
| commit | a9157ce950dfe2fc30795d43b9d79b9d1bffc48b (patch) | |
| tree | 9df484304b560466d145e662c1c254ff0e9ae0ba /static/openbsd/man3/menu_win.3 | |
| parent | 160aa82b2d39c46ad33723d7d909cb4972efbb03 (diff) | |
docs: Added All OpenBSD Manuals
Diffstat (limited to 'static/openbsd/man3/menu_win.3')
| -rw-r--r-- | static/openbsd/man3/menu_win.3 | 97 |
1 files changed, 97 insertions, 0 deletions
diff --git a/static/openbsd/man3/menu_win.3 b/static/openbsd/man3/menu_win.3 new file mode 100644 index 00000000..4b439a22 --- /dev/null +++ b/static/openbsd/man3/menu_win.3 @@ -0,0 +1,97 @@ +'\" t +.\" $OpenBSD: menu_win.3,v 1.9 2023/10/17 09:52:10 nicm Exp $ +.\" +.\"*************************************************************************** +.\" Copyright 2018-2022,2023 Thomas E. Dickey * +.\" Copyright 1998-2006,2010 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.3,v 1.9 2023/10/17 09:52:10 nicm Exp $ +.TH menu_win 3 2023-07-01 "ncurses 6.4" "Library calls" +.SH NAME +\fBmenu_win\fP \- make and break menu window and subwindow associations +.SH SYNOPSIS +\fB#include <menu.h>\fP +.sp +\fBint set_menu_win(MENU *\fImenu\fB, WINDOW *\fIwin\fB);\fR +.br +\fBWINDOW *menu_win(const MENU *\fImenu\fB);\fR +.sp +\fBint set_menu_sub(MENU *\fImenu\fB, WINDOW *\fIsub\fB);\fR +.br +\fBWINDOW *menu_sub(const MENU *\fImenu\fB);\fR +.sp +\fBint scale_menu(const MENU *\fImenu, int *\fIrows\fB, int *\fIcolumns);\fR +.SH DESCRIPTION +Every menu has an associated pair of \fBcurses\fP 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\fP for both. +.PP +In the \fBset_\fP functions, window argument of \fBNULL\fP is treated as though +it were \fBstsdcr\fP. A menu argument of \fBNULL\fP is treated as a request +to change the system default menu window or subwindow. +.PP +The function \fBscale_menu\fP returns the minimum size required for the +subwindow of \fImenu\fP. +.SH RETURN VALUE +Routines that return pointers return \fBNULL\fP 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\fP(3)). +.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\fP(3), +\fBcurs_variables\fP(3), +\fBmenu\fP(3). +.SH NOTES +The header file \fB<menu.h>\fP automatically includes the header file +\fB<curses.h>\fP. +.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. |
