ncurses 6.2 - patch 20211018
[ncurses.git] / doc / html / man / menu_win.3x.html
1 <!--
2   * t
3   ****************************************************************************
4   * Copyright 2018-2019,2020 Thomas E. Dickey                                *
5   * Copyright 1998-2006,2010 Free Software Foundation, Inc.                  *
6   *                                                                          *
7   * Permission is hereby granted, free of charge, to any person obtaining a  *
8   * copy of this software and associated documentation files (the            *
9   * "Software"), to deal in the Software without restriction, including      *
10   * without limitation the rights to use, copy, modify, merge, publish,      *
11   * distribute, distribute with modifications, sublicense, and/or sell       *
12   * copies of the Software, and to permit persons to whom the Software is    *
13   * furnished to do so, subject to the following conditions:                 *
14   *                                                                          *
15   * The above copyright notice and this permission notice shall be included  *
16   * in all copies or substantial portions of the Software.                   *
17   *                                                                          *
18   * THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS  *
19   * OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF               *
20   * MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT.   *
21   * IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM,   *
22   * DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR    *
23   * OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR    *
24   * THE USE OR OTHER DEALINGS IN THE SOFTWARE.                               *
25   *                                                                          *
26   * Except as contained in this notice, the name(s) of the above copyright   *
27   * holders shall not be used in advertising or otherwise to promote the     *
28   * sale, use or other dealings in this Software without prior written       *
29   * authorization.                                                           *
30   ****************************************************************************
31   * @Id: menu_win.3x,v 1.15 2020/10/17 23:50:51 tom Exp @
32 -->
33 <!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">
34 <HTML>
35 <HEAD>
36 <meta http-equiv="Content-Type" content="text/html; charset=us-ascii">
37 <meta name="generator" content="Manpage converted by man2html - see https://invisible-island.net/scripts/readme.html#others_scripts">
38 <TITLE>menu_win 3x</TITLE>
39 <link rel="author" href="mailto:bug-ncurses@gnu.org">
40 <meta http-equiv="Content-Type" content="text/html; charset=iso-8859-1">
41 </HEAD>
42 <BODY>
43 <H1 class="no-header">menu_win 3x</H1>
44 <PRE>
45 <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>                                                      <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
46
47
48
49
50 </PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>
51        <STRONG>menu_win</STRONG> - make and break menu window and subwindow associations
52
53
54 </PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>
55        <STRONG>#include</STRONG> <STRONG>&lt;menu.h&gt;</STRONG>
56
57        <STRONG>int</STRONG> <STRONG>set_menu_win(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>win</EM><STRONG>);</STRONG>
58        <STRONG>WINDOW</STRONG> <STRONG>*menu_win(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
59
60        <STRONG>int</STRONG> <STRONG>set_menu_sub(MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>,</STRONG> <STRONG>WINDOW</STRONG> <STRONG>*</STRONG><EM>sub</EM><STRONG>);</STRONG>
61        <STRONG>WINDOW</STRONG> <STRONG>*menu_sub(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu</EM><STRONG>);</STRONG>
62
63        <STRONG>int</STRONG> <STRONG>scale_menu(const</STRONG> <STRONG>MENU</STRONG> <STRONG>*</STRONG><EM>menu,</EM> <EM>int</EM> <EM>*rows</EM><STRONG>,</STRONG> <STRONG>int</STRONG> <STRONG>*</STRONG><EM>columns);</EM>
64
65
66 </PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>
67        Every  menu  has an associated pair of <STRONG>curses</STRONG> windows.  The menu window
68        displays any title and border associated  with  the  window;  the  menu
69        subwindow  displays  the items of the menu that are currently available
70        for selection.
71
72        The first four  functions  get  and  set  those  windows.   It  is  not
73        necessary to set either window; by default, the driver code uses <STRONG>stdscr</STRONG>
74        for both.
75
76        In the <STRONG>set_</STRONG> functions, window argument of <STRONG>NULL</STRONG> is treated as though  it
77        were <STRONG>stsdcr</STRONG>.  A menu argument of <STRONG>NULL</STRONG> is treated as a request to change
78        the system default menu window or subwindow.
79
80        The function <STRONG>scale_menu</STRONG> returns  the  minimum  size  required  for  the
81        subwindow of <EM>menu</EM>.
82
83
84 </PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>
85        Routines  that  return  pointers  return  <STRONG>NULL</STRONG> on error.  Routines that
86        return an integer return one of the following error codes:
87
88        <STRONG>E_OK</STRONG> The routine succeeded.
89
90        <STRONG>E_SYSTEM_ERROR</STRONG>
91             System error occurred (see <STRONG>errno(3)</STRONG>).
92
93        <STRONG>E_BAD_ARGUMENT</STRONG>
94             Routine detected an incorrect or out-of-range argument.
95
96        <STRONG>E_POSTED</STRONG>
97             The menu has already been posted.
98
99        <STRONG>E_NOT_CONNECTED</STRONG>
100             No items are connected to the menu.
101
102
103 </PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>
104        <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>.
105
106
107 </PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>
108        The  header  file  <STRONG>&lt;menu.h&gt;</STRONG>  automatically  includes  the  header  file
109        <STRONG>&lt;curses.h&gt;</STRONG>.
110
111
112 </PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>
113        These  routines  emulate  the  System  V  menu  library.  They were not
114        supported on Version 7 or BSD versions.
115
116
117 </PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>
118        Juergen Pfeifer.  Manual pages and adaptation for new curses by Eric S.
119        Raymond.
120
121
122
123                                                                   <STRONG><A HREF="menu_win.3x.html">menu_win(3x)</A></STRONG>
124 </PRE>
125 <div class="nav">
126 <ul>
127 <li><a href="#h2-NAME">NAME</a></li>
128 <li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>
129 <li><a href="#h2-DESCRIPTION">DESCRIPTION</a></li>
130 <li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>
131 <li><a href="#h2-SEE-ALSO">SEE ALSO</a></li>
132 <li><a href="#h2-NOTES">NOTES</a></li>
133 <li><a href="#h2-PORTABILITY">PORTABILITY</a></li>
134 <li><a href="#h2-AUTHORS">AUTHORS</a></li>
135 </ul>
136 </div>
137 </BODY>
138 </HTML>