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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame^]

1

<!DOCTYPE HTML PUBLIC "-//IETF//DTD HTML 2.0//EN">

2

<!--

3

* t

4

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

5

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.3x,v 1.19 2006/11/04 18:38:29 tom Exp @

-->

<HTML>

<HEAD>

</HEAD>

<BODY>

<HR>

<PRE>

</PRE>

menu - curses extension for programming menus

</PRE>

<H2>SYNOPSIS</H2><PRE>

#include <menu.h>

</PRE>

<H2>DESCRIPTION</H2><PRE>

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

73

Current Default Values for Item Attributes

74

The menu library maintains a default value for item

75

attributes. You can get or set this default by calling

76

the appropriate get_ or set_ routine with a NULL item

77

pointer. Changing this default with a set_ function

78

affects future item creations, but does not change the

79

rendering of items already created.

80

81

Routine Name Index

82

The following table lists each menu routine and the name

83

of the manual page on which it is described.

84

85

curses Routine Name Manual Page Name

86

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

87

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

88

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

89

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

90

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

91

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

92

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

93

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

94

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

95

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

96

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

97

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

98

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

99

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

100

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

101

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

102

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

103

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

104

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

105

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

106

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

107

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

108

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

109

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

110

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

111

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

112

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

113

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

114

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

115

116

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

117

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

118

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

119

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

120

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

121

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

122

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

123

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

124

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

125

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

126

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

127

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

128

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

129

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

130

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

131

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

132

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

133

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

134

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

135

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

136

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

137

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

138

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

139

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

140

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

141

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

142

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

143

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

144

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

145

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

146

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

147

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

148

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

149

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

150

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

151

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

</PRE>

<H2>RETURN VALUE</H2><PRE>

156

Routines that return pointers return NULL on error. Rou-

157

tines that return an integer return one of the following

158

error codes:

159

160

E_OK The routine succeeded.

161

162

E_BAD_ARGUMENT

163

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.

172

173

E_NO_ROOM

174

Menu is too large for its window.

175

176

E_NOT_CONNECTED

177

No items are connected to the menu.

178

179

E_NOT_POSTED

180

The menu has not been posted.

181

182

E_NOT_SELECTABLE

183

The designated item cannot be selected.

184

185

E_POSTED

186

The menu is already posted.

187

188

E_REQUEST_DENIED

189

The menu driver could not process the request.

190

191

E_SYSTEM_ERROR

192

System error occurred (see errno).

193

194

E_UNKNOWN_COMMAND

195

The menu driver code saw an unknown request code.

</PRE>

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

201

detailed descriptions of the entry points.

</PRE>

<H2>NOTES</H2><PRE>

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

207

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

208

209

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

210

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

211

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

error).

</PRE>

<H2>PORTABILITY</H2><PRE>

217

These routines emulate the System V menu library. They

218

were not supported on Version 7 or BSD versions.

</PRE>

<H2>AUTHORS</H2><PRE>

223

Juergen Pfeifer. Manual pages and adaptation for ncurses

by Eric S. Raymond.

</PRE>

This describes ncurses version 5.6 (patch 20081011).

</PRE>

<HR>

Man(1) output converted with

</ADDRESS>

</BODY>

</HTML>