Blame - doc/html/man/menu.3x.html - android_external_libncurses

2025-07-08 18:04:53 -0400

[diff] [blame]

1

<!--

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

2

* t

3

****************************************************************************

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

4

5

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

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

****************************************************************************

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

31

* @Id: menu.3x,v 1.45 2024/03/16 15:35:01 tom Exp @

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

32

-->

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

33

<!DOCTYPE html PUBLIC "-//W3C//DTD HTML 4.01//EN">

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

34

<HTML>

35

<HEAD>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

36

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

37

38

<TITLE>menu 3x 2024-03-16 ncurses 6.5 Library calls</TITLE>

39

40

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

41

</HEAD>

42

<BODY>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

43

<H1 class="no-header">menu 3x 2024-03-16 ncurses 6.5 Library calls</H1>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

44

<PRE>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

45

<A HREF="menu.3x.html">menu(3x)</A> Library calls <A HREF="menu.3x.html">menu(3x)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

50

</PRE><H2><a name="h2-NAME">NAME</a></H2><PRE>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

51

menu - curses extension for programming menus

52

53

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

54

</PRE><H2><a name="h2-SYNOPSIS">SYNOPSIS</a></H2><PRE>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

#include <menu.h>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

58

</PRE><H2><a name="h2-DESCRIPTION">DESCRIPTION</a></H2><PRE>

59

The menu library provides terminal-independent facilities for composing

60

menu systems on character-cell terminals. The library includes: item

61

routines, which create and modify menu items; and menu routines, which

62

group items into menus, display menus on the screen, and handle

63

interaction with the user.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

64

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

65

The menu library uses the curses libraries, and a curses initialization

66

routine such as initscr must be called before using any of these

67

functions. To use the menu library, link with the options -lmenu

68

-lcurses.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

69

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

70

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

71

</PRE><H3><a name="h3-Current-Default-Values-for-Item-Attributes">Current Default Values for Item Attributes</a></H3><PRE>

72

The menu library maintains a default value for item attributes. You

73

can get or set this default by calling the appropriate get_ or set_

74

routine with a NULL item pointer. Changing this default with a set_

75

function affects future item creations, but does not change the

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

76

rendering of items already created.

77

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

78

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

79

</PRE><H3><a name="h3-Routine-Name-Index">Routine Name Index</a></H3><PRE>

80

The following table lists each menu routine and the name of the manual

81

page on which it is described.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

82

83

curses Routine Name Manual Page Name

84

--------------------------------------------

85

current_item <A HREF="mitem_current.3x.html">mitem_current(3x)</A>

86

free_item <A HREF="mitem_new.3x.html">mitem_new(3x)</A>

87

free_menu <A HREF="menu_new.3x.html">menu_new(3x)</A>

88

item_count <A HREF="menu_items.3x.html">menu_items(3x)</A>

89

item_description <A HREF="mitem_name.3x.html">mitem_name(3x)</A>

90

item_index <A HREF="mitem_current.3x.html">mitem_current(3x)</A>

91

item_init <A HREF="menu_hook.3x.html">menu_hook(3x)</A>

92

item_name <A HREF="mitem_name.3x.html">mitem_name(3x)</A>

93

item_opts <A HREF="mitem_opts.3x.html">mitem_opts(3x)</A>

94

item_opts_off <A HREF="mitem_opts.3x.html">mitem_opts(3x)</A>

95

item_opts_on <A HREF="mitem_opts.3x.html">mitem_opts(3x)</A>

96

item_term <A HREF="menu_hook.3x.html">menu_hook(3x)</A>

97

item_userptr <A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A>

98

item_value <A HREF="mitem_value.3x.html">mitem_value(3x)</A>

99

item_visible <A HREF="mitem_visible.3x.html">mitem_visible(3x)</A>

100

menu_back <A HREF="menu_attributes.3x.html">menu_attributes(3x)</A>

101

menu_driver <A HREF="menu_driver.3x.html">menu_driver(3x)</A>

102

menu_fore <A HREF="menu_attributes.3x.html">menu_attributes(3x)</A>

103

menu_format <A HREF="menu_format.3x.html">menu_format(3x)</A>

104

menu_grey <A HREF="menu_attributes.3x.html">menu_attributes(3x)</A>

105

menu_init <A HREF="menu_hook.3x.html">menu_hook(3x)</A>

106

menu_items <A HREF="menu_items.3x.html">menu_items(3x)</A>

107

menu_mark <A HREF="menu_mark.3x.html">menu_mark(3x)</A>

108

menu_opts <A HREF="menu_opts.3x.html">menu_opts(3x)</A>

109

menu_opts_off <A HREF="menu_opts.3x.html">menu_opts(3x)</A>

110

menu_opts_on <A HREF="menu_opts.3x.html">menu_opts(3x)</A>

111

menu_pad <A HREF="menu_attributes.3x.html">menu_attributes(3x)</A>

112

menu_pattern <A HREF="menu_pattern.3x.html">menu_pattern(3x)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

113

menu_request_by_name <A HREF="menu_requestname.3x.html">menu_requestname(3x)</A>

114

menu_request_name <A HREF="menu_requestname.3x.html">menu_requestname(3x)</A>

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

115

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

116

menu_spacing <A HREF="menu_spacing.3x.html">menu_spacing(3x)</A>

117

menu_sub <A HREF="menu_win.3x.html">menu_win(3x)</A>

118

menu_term <A HREF="menu_hook.3x.html">menu_hook(3x)</A>

119

menu_userptr <A HREF="menu_userptr.3x.html">menu_userptr(3x)</A>

120

menu_win <A HREF="menu_win.3x.html">menu_win(3x)</A>

121

new_item <A HREF="mitem_new.3x.html">mitem_new(3x)</A>

122

new_menu <A HREF="menu_new.3x.html">menu_new(3x)</A>

123

pos_menu_cursor <A HREF="menu_cursor.3x.html">menu_cursor(3x)</A>

124

post_menu <A HREF="menu_post.3x.html">menu_post(3x)</A>

125

scale_menu <A HREF="menu_win.3x.html">menu_win(3x)</A>

126

set_current_item <A HREF="mitem_current.3x.html">mitem_current(3x)</A>

127

set_item_init <A HREF="menu_hook.3x.html">menu_hook(3x)</A>

128

set_item_opts <A HREF="mitem_opts.3x.html">mitem_opts(3x)</A>

129

set_item_term <A HREF="menu_hook.3x.html">menu_hook(3x)</A>

130

set_item_userptr <A HREF="mitem_userptr.3x.html">mitem_userptr(3x)</A>

131

set_item_value <A HREF="mitem_value.3x.html">mitem_value(3x)</A>

132

set_menu_back <A HREF="menu_attributes.3x.html">menu_attributes(3x)</A>

133

set_menu_fore <A HREF="menu_attributes.3x.html">menu_attributes(3x)</A>

134

set_menu_format <A HREF="menu_format.3x.html">menu_format(3x)</A>

135

set_menu_grey <A HREF="menu_attributes.3x.html">menu_attributes(3x)</A>

136

set_menu_init <A HREF="menu_hook.3x.html">menu_hook(3x)</A>

137

set_menu_items <A HREF="menu_items.3x.html">menu_items(3x)</A>

138

set_menu_mark <A HREF="menu_mark.3x.html">menu_mark(3x)</A>

139

set_menu_opts <A HREF="mitem_opts.3x.html">mitem_opts(3x)</A>

140

set_menu_pad <A HREF="menu_attributes.3x.html">menu_attributes(3x)</A>

141

set_menu_pattern <A HREF="menu_pattern.3x.html">menu_pattern(3x)</A>

142

set_menu_spacing <A HREF="menu_spacing.3x.html">menu_spacing(3x)</A>

143

set_menu_sub <A HREF="menu_win.3x.html">menu_win(3x)</A>

144

set_menu_term <A HREF="menu_hook.3x.html">menu_hook(3x)</A>

145

set_menu_userptr <A HREF="menu_userptr.3x.html">menu_userptr(3x)</A>

146

set_menu_win <A HREF="menu_win.3x.html">menu_win(3x)</A>

147

set_top_row <A HREF="mitem_current.3x.html">mitem_current(3x)</A>

148

top_row <A HREF="mitem_current.3x.html">mitem_current(3x)</A>

149

unpost_menu <A HREF="menu_post.3x.html">menu_post(3x)</A>

150

151

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

152

</PRE><H2><a name="h2-RETURN-VALUE">RETURN VALUE</a></H2><PRE>

153

Routines that return pointers return NULL on error. Routines that

154

return an integer return one of the following error codes:

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

155

156

E_OK The routine succeeded.

157

158

E_BAD_ARGUMENT

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

159

Routine detected an incorrect or out-of-range argument.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

160

161

E_BAD_STATE

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

162

Routine was called from an initialization or termination function.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

163

164

E_NO_MATCH

165

Character failed to match.

166

167

E_NO_ROOM

168

Menu is too large for its window.

169

170

E_NOT_CONNECTED

171

No items are connected to the menu.

172

173

E_NOT_POSTED

174

The menu has not been posted.

175

176

E_NOT_SELECTABLE

177

The designated item cannot be selected.

178

179

E_POSTED

180

The menu is already posted.

181

182

E_REQUEST_DENIED

183

The menu driver could not process the request.

184

185

E_SYSTEM_ERROR

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

186

System error occurred (see errno(3)).

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

187

188

E_UNKNOWN_COMMAND

189

The menu driver code saw an unknown request code.

190

191

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

192

</PRE><H2><a name="h2-NOTES">NOTES</a></H2><PRE>

193

The header file menu.h itself includes the header file curses.h.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

194

195

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

196

</PRE><H2><a name="h2-PORTABILITY">PORTABILITY</a></H2><PRE>

197

These routines emulate the System V menu library. They were not

198

supported on Version 7 or BSD versions.

199

200

A menu facility was documented in SVr4.2's Character User Interface

201

Programming document.

202

203

It is not part of X/Open Curses.

204

205

Aside from ncurses, there are few implementations:

206

207

o systems based on SVr4 source code, e.g., Solaris.

208

209

o NetBSD curses.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

210

211

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

212

</PRE><H2><a name="h2-AUTHORS">AUTHORS</a></H2><PRE>

213

Juergen Pfeifer. Manual pages and adaptation for ncurses by Eric S.

214

Raymond.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

215

216

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

217

</PRE><H2><a name="h2-SEE-ALSO">SEE ALSO</a></H2><PRE>

218

<A HREF="ncurses.3x.html">curses(3x)</A> and related pages whose names begin "menu_" for detailed

219

descriptions of the entry points.

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

micky387

2025-07-08 18:04:53 -0400

[diff] [blame]

223

ncurses 6.5 2024-03-16 <A HREF="menu.3x.html">menu(3x)</A>

Amit Daniel Kachhap

2011-07-20 11:45:59 +0530

[diff] [blame]

224

</PRE>

Steve Kondik

2015-11-15 02:50:53 +0100

[diff] [blame]

<ul>

<li><a href="#h2-SYNOPSIS">SYNOPSIS</a></li>

229

<li><a href="#h2-DESCRIPTION">DESCRIPTION</a>

230

<ul>

231

<li><a href="#h3-Current-Default-Values-for-Item-Attributes">Current Default Values for Item Attributes</a></li>

232

<li><a href="#h3-Routine-Name-Index">Routine Name Index</a></li>

233

</ul>

234

</li>

235

<li><a href="#h2-RETURN-VALUE">RETURN VALUE</a></li>

236

<li><a href="#h2-NOTES">NOTES</a></li>

237

<li><a href="#h2-PORTABILITY">PORTABILITY</a></li>

238

<li><a href="#h2-AUTHORS">AUTHORS</a></li>

239

240

</ul>

241

</div>

Amit Daniel Kachhap