-<!--
+<!--
* t
****************************************************************************
- * Copyright (c) 1998-2010,2018 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 *
* 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 @
+ * @Id: menu_win.3x,v 1.15 2020/10/17 23:50:51 tom Exp @
-->
<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
<HTML>
<HEAD>
<meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
<meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
-<TITLE>menu_win 3x</TITLE>
-<link rev=made href="mailto:bug-ncurses@gnu.org">
+<TITLE>menu_win 3X</TITLE>
+<link rel="author" href="mailto:bug-ncurses@gnu.org">
<meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
</HEAD>
<BODY>
-<H1 class="no-header">menu_win 3x</H1>
+<H1 class="no-header">menu_win 3X</H1>
<PRE>
-<STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG> <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
+<B><A HREF="menu_win.3X.html">menu_win(3X)</A></B> <B><A HREF="menu_win.3X.html">menu_win(3X)</A></B>
</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
- <STRONG>menu_win</STRONG> - make and break menu window and subwindow associations
+ <B>menu_win</B> - make and break menu window and subwindow associations
</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
- <STRONG>#include</STRONG> <STRONG><menu.h></STRONG>
- int set_menu_win(MENU *menu, WINDOW *win);
- WINDOW *menu_win(const MENU *menu);
- int set_menu_sub(MENU *menu, WINDOW *sub);
- WINDOW *menu_sub(const MENU *menu);
- int scale_menu(const MENU *menu, int *rows, int *columns);
+ <B>#include</B> <B><menu.h></B>
+
+ <B>int</B> <B>set_menu_win(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>WINDOW</B> <B>*</B><I>win</I><B>);</B>
+ <B>WINDOW</B> <B>*menu_win(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
+
+ <B>int</B> <B>set_menu_sub(MENU</B> <B>*</B><I>menu</I><B>,</B> <B>WINDOW</B> <B>*</B><I>sub</I><B>);</B>
+ <B>WINDOW</B> <B>*menu_sub(const</B> <B>MENU</B> <B>*</B><I>menu</I><B>);</B>
+
+ <B>int</B> <B>scale_menu(const</B> <B>MENU</B> <B>*</B><I>menu,</I> <I>int</I> <I>*rows</I><B>,</B> <B>int</B> <B>*</B><I>columns);</I>
</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
- Every menu has an associated pair of <STRONG>curses</STRONG> windows. The menu window
- displays any title and border associated with the window; the menu sub-
- window displays the items of the menu that are currently available for
- selection.
+ Every menu has an associated pair of <B>curses</B> 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 neces-
- sary to set either window; by default, the driver code uses <STRONG>stdscr</STRONG> 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 <B>stdscr</B>
+ for both.
- In the <STRONG>set_</STRONG> functions, window argument of <STRONG>NULL</STRONG> is treated as though it
- were <STRONG>stsdcr</STRONG>. A menu argument of <STRONG>NULL</STRONG> is treated as a request to change
+ In the <B>set_</B> functions, window argument of <B>NULL</B> is treated as though it
+ were <B>stsdcr</B>. A menu argument of <B>NULL</B> is treated as a request to change
the system default menu window or subwindow.
- The function <STRONG>scale_menu</STRONG> returns the minimum size required for the sub-
- window of <EM>menu</EM>.
+ The function <B>scale_menu</B> returns the minimum size required for the
+ subwindow of <I>menu</I>.
</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
- Routines that return pointers return <STRONG>NULL</STRONG> on error. Routines that
+ Routines that return pointers return <B>NULL</B> on error. Routines that
return an integer return one of the following error codes:
- <STRONG>E_OK</STRONG> The routine succeeded.
+ <B>E_OK</B> The routine succeeded.
- <STRONG>E_SYSTEM_ERROR</STRONG>
- System error occurred (see <STRONG>errno</STRONG>).
+ <B>E_SYSTEM_ERROR</B>
+ System error occurred (see <B>errno(3)</B>).
- <STRONG>E_BAD_ARGUMENT</STRONG>
+ <B>E_BAD_ARGUMENT</B>
Routine detected an incorrect or out-of-range argument.
- <STRONG>E_POSTED</STRONG>
+ <B>E_POSTED</B>
The menu has already been posted.
- <STRONG>E_NOT_CONNECTED</STRONG>
+ <B>E_NOT_CONNECTED</B>
No items are connected to the menu.
</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
- <STRONG><A HREF="ncurses.3x.html">curses(3x)</A></STRONG>, <STRONG><A HREF="curs_variables.3x.html">curs_variables(3x)</A></STRONG>, <STRONG><A HREF="menu.3x.html">menu(3x)</A></STRONG>.
+ <B><A HREF="curses.3X.html">curses(3X)</A></B>, <B><A HREF="curs_variables.3X.html">curs_variables(3X)</A></B>, <B><A HREF="menu.3X.html">menu(3X)</A></B>.
</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
- The header file <STRONG><menu.h></STRONG> automatically includes the header file
- <STRONG><curses.h></STRONG>.
+ The header file <B><menu.h></B> automatically includes the header file
+ <B><curses.h></B>.
</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
- These routines emulate the System V menu library. They were not sup-
- ported on Version 7 or BSD versions.
+ These routines emulate the System V menu library. They were not
+ supported on Version 7 or BSD versions.
</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
- <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
+ <B><A HREF="menu_win.3X.html">menu_win(3X)</A></B>
</PRE>
<div class="nav">
<ul>
projects / ncurses.git / blobdiff