X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_win.3x;h=ae764ec9a1264272210ff9dba86606027234bb0e;hp=336da44b0c5b9db1d807495b0c036c4d918ea37d;hb=a6eb34d7fec8170a8715f9e53ca2f96452dd30dd;hpb=0eb88fc5281804773e2a0c7a488a4452463535ce diff --git a/man/menu_win.3x b/man/menu_win.3x index 336da44b..ae764ec9 100644 --- a/man/menu_win.3x +++ b/man/menu_win.3x @@ -1,6 +1,7 @@ '\" t .\"*************************************************************************** -.\" Copyright (c) 1998 Free Software Foundation, Inc. * +.\" Copyright 2018-2019,2020 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 * @@ -27,69 +28,69 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_win.3x,v 1.6 1998/11/29 01:11:11 Rick.Ohnemus Exp $ +.\" $Id: menu_win.3x,v 1.15 2020/10/17 23:50:51 tom Exp $ .TH menu_win 3X "" .SH NAME -\fBmenu_win\fR - make and break menu window and subwindow associations +\fBmenu_win\fR \- make and break menu window and subwindow associations .SH SYNOPSIS \fB#include \fR +.sp +\fBint set_menu_win(MENU *\fP\fImenu\fP\fB, WINDOW *\fP\fIwin\fP\fB);\fP .br -int set_menu_win(MENU *menu, WINDOW *win); +\fBWINDOW *menu_win(const MENU *\fP\fImenu\fP\fB);\fP +.sp +\fBint set_menu_sub(MENU *\fP\fImenu\fP\fB, WINDOW *\fP\fIsub\fP\fB);\fP .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); +\fBWINDOW *menu_sub(const MENU *\fP\fImenu\fP\fB);\fP +.sp +\fBint scale_menu(const MENU *\fP\fImenu, int *\fP\fIrows\fP\fB, int *\fP\fIcolumns);\fP .br .SH DESCRIPTION -Every menu has an associated pair of \fBcurses\fR windows. The menu window +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. - -The first four functions get and set those windows. It is not necessary to set +.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 +Routines that return pointers return \fBNULL\fR on error. +Routines that return an integer return one of the following error codes: .TP 5 -\fBE_OK\fR +.B E_OK The routine succeeded. .TP 5 -\fBE_SYSTEM_ERROR\fR -System error occurred (see \fBerrno\fR). +.B E_SYSTEM_ERROR +System error occurred (see \fBerrno\fR(3)). .TP 5 -\fBE_BAD_ARGUMENT\fR +.B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. .TP 5 -\fBE_POSTED\fR +.B E_POSTED The menu has already been posted. .TP 5 -\fBE_NOT_CONNECTED\fR +.B E_NOT_CONNECTED No items are connected to the menu. .SH SEE ALSO -\fBcurses\fR(3X), \fBmenu\fR(3X). +\fBcurses\fR(3X), +\fBcurs_variables\fR(3X), +\fBmenu\fR(3X). .SH NOTES The header file \fB\fR automatically includes the header file \fB\fR. .SH PORTABILITY -These routines emulate the System V menu library. They were not supported on +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. -.\"# -.\"# The following sets edit modes for GNU EMACS -.\"# Local Variables: -.\"# mode:nroff -.\"# fill-column:79 -.\"# End: +Juergen Pfeifer. +Manual pages and adaptation for new curses by Eric S. Raymond.