X-Git-Url: https://ncurses.scripts.mit.edu/?p=ncurses.git;a=blobdiff_plain;f=man%2Fmenu_win.3x;h=36f6129dc2a869224312b5a59b51d08468bde871;hp=48af2f89e4d5be564634b4d8dd2c077e58752d4c;hb=HEAD;hpb=cef50b3afcd58166f3541b701c97bce538844c76 diff --git a/man/menu_win.3x b/man/menu_win.3x index 48af2f89..36f6129d 100644 --- a/man/menu_win.3x +++ b/man/menu_win.3x @@ -1,6 +1,6 @@ -'\" t .\"*************************************************************************** -.\" Copyright (c) 1998-2006,2010 Free Software Foundation, Inc. * +.\" Copyright 2018-2023,2024 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,46 +27,49 @@ .\" authorization. * .\"*************************************************************************** .\" -.\" $Id: menu_win.3x,v 1.10 2010/10/02 23:22:24 tom Exp $ -.TH menu_win 3X "" +.\" $Id: menu_win.3x,v 1.32 2024/03/16 15:35:01 tom Exp $ +.TH menu_win 3X 2024-03-16 "ncurses @NCURSES_MAJOR@.@NCURSES_MINOR@" "Library calls" .SH NAME -\fBmenu_win\fR \- make and break menu window and subwindow associations +\fBmenu_win\fP \- +make and break menu window and subwindow associations .SH SYNOPSIS -\fB#include \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 +.nf +\fB#include +.PP +\fBint set_menu_win(MENU *\fImenu\fP, WINDOW *\fIwin\fP); +\fBWINDOW *menu_win(const MENU *\fImenu\fP); +.PP +\fBint set_menu_sub(MENU *\fImenu\fP, WINDOW *\fIsub\fP); +\fBWINDOW *menu_sub(const MENU *\fImenu\fP); +.PP +\fBint scale_menu(const MENU *\fImenu\fP, int *\fIrows\fP, int *\fIcolumns\fP); +.fi .SH DESCRIPTION -Every menu has an associated pair of \fBcurses\fR windows. The menu window +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\fR for both. +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_\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 +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\fR returns the minimum size required for the -subwindow of \fImenu\fR. +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\fR on error. Routines that return +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\fR). +System error occurred (see \fBerrno\fP(3)). .TP 5 .B E_BAD_ARGUMENT Routine detected an incorrect or out-of-range argument. @@ -76,22 +79,14 @@ 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\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. +.SH SEE ALSO +\fB\%curses\fP(3X), +\fB\%curs_variables\fP(3X), +\fB\%menu\fP(3X)