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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

1

<!--

2

* t

3

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

Steve Kondik

ae271bc

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

[diff] [blame]

4

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

5

* *

6

* Permission is hereby granted, free of charge, to any person obtaining a *

7

* copy of this software and associated documentation files (the *

8

* "Software"), to deal in the Software without restriction, including *

9

* without limitation the rights to use, copy, modify, merge, publish, *

10

* distribute, distribute with modifications, sublicense, and/or sell *

11

* copies of the Software, and to permit persons to whom the Software is *

12

* furnished to do so, subject to the following conditions: *

13

* *

14

* The above copyright notice and this permission notice shall be included *

15

* in all copies or substantial portions of the Software. *

16

* *

17

* THE SOFTWARE IS PROVIDED "AS IS", WITHOUT WARRANTY OF ANY KIND, EXPRESS *

18

* OR IMPLIED, INCLUDING BUT NOT LIMITED TO THE WARRANTIES OF *

19

* MERCHANTABILITY, FITNESS FOR A PARTICULAR PURPOSE AND NONINFRINGEMENT. *

20

* IN NO EVENT SHALL THE ABOVE COPYRIGHT HOLDERS BE LIABLE FOR ANY CLAIM, *

21

* DAMAGES OR OTHER LIABILITY, WHETHER IN AN ACTION OF CONTRACT, TORT OR *

22

* OTHERWISE, ARISING FROM, OUT OF OR IN CONNECTION WITH THE SOFTWARE OR *

23

* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *

24

* *

25

* Except as contained in this notice, the name(s) of the above copyright *

26

* holders shall not be used in advertising or otherwise to promote the *

27

* sale, use or other dealings in this Software without prior written *

28

* authorization. *

29

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

Steve Kondik

ae271bc

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

[diff] [blame]

30

* @Id: menu.3x,v 1.22 2014/08/16 20:32:08 tom Exp @

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

31

-->

Steve Kondik

ae271bc

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

[diff] [blame]

32

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

33

<HTML>

34

<HEAD>

Steve Kondik

ae271bc

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

[diff] [blame]

35

36

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

</HEAD>

<BODY>

Steve Kondik

ae271bc

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

[diff] [blame]

42

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

43

<PRE>

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

50

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

51

menu - curses extension for programming menus

52

53

54

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

55

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

#include <menu.h>

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

60

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

61

The menu library provides terminal-independent facilities

62

for composing menu systems on character-cell terminals.

63

The library includes: item routines, which create and mod-

64

ify menu items; and menu routines, which group items into

65

menus, display menus on the screen, and handle interaction

66

with the user.

67

68

The menu library uses the curses libraries, and a curses

69

initialization routine such as initscr must be called

70

before using any of these functions. To use the menu

71

library, link with the options -lmenu -lcurses.

72

Steve Kondik

ae271bc

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

[diff] [blame]

73

74

</PRE>

75

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

76

The menu library maintains a default value for item

77

attributes. You can get or set this default by calling

78

the appropriate get_ or set_ routine with a NULL item

79

pointer. Changing this default with a set_ function

80

affects future item creations, but does not change the

81

rendering of items already created.

82

Steve Kondik

ae271bc

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

[diff] [blame]

83

84

</PRE>

85

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

86

The following table lists each menu routine and the name

87

of the manual page on which it is described.

88

89

curses Routine Name Manual Page Name

90

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

91

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

92

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

93

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

94

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

95

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

96

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

97

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

98

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

99

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

100

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

101

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

102

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

103

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

104

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

105

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

106

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

107

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

108

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

109

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

110

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

111

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

112

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

113

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

114

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

115

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

116

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

117

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

118

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

119

120

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

121

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

122

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

123

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

124

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

125

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

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

152

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

153

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

154

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

155

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

156

157

158

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

159

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

160

Routines that return pointers return NULL on error. Rou-

161

tines that return an integer return one of the following

162

error codes:

163

164

E_OK The routine succeeded.

165

166

E_BAD_ARGUMENT

167

Routine detected an incorrect or out-of-range argu-

ment.

E_BAD_STATE

Routine was called from an initialization or termina-

tion function.

E_NO_MATCH

Character failed to match.

176

177

E_NO_ROOM

178

Menu is too large for its window.

179

180

E_NOT_CONNECTED

181

No items are connected to the menu.

182

183

E_NOT_POSTED

184

The menu has not been posted.

185

186

E_NOT_SELECTABLE

187

The designated item cannot be selected.

188

189

E_POSTED

190

The menu is already posted.

191

192

E_REQUEST_DENIED

193

The menu driver could not process the request.

194

195

E_SYSTEM_ERROR

196

System error occurred (see errno).

197

198

E_UNKNOWN_COMMAND

199

The menu driver code saw an unknown request code.

200

201

202

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

203

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

204

The header file <menu.h> automatically includes the header

205

files <curses.h> and <eti.h>.

206

Steve Kondik

ae271bc

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

[diff] [blame]

207

In your library list, libmenu.a should be before libn-

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

208

curses.a; that is, you want to say `-lmenu -lncurses', not

Steve Kondik

ae271bc

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

[diff] [blame]

209

the other way around (which would usually give a link-

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

error).

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

214

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

215

These routines emulate the System V menu library. They

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

216

were not supported on Version 7 or BSD versions.

217

218

219

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

220

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

221

Juergen Pfeifer. Manual pages and adaptation for ncurses

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

by Eric S. Raymond.

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

226

227

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

228

detailed descriptions of the entry points.

229

230

This describes ncurses version 6.0 (patch 20150808).

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

<ul>

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

240

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

241

<ul>

242

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

243

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

244

</ul>

245

</li>

246

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

247

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

248

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

249

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

250

251

</ul>

252

</div>

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

253

</BODY>

254

</HTML>