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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

1

<!--

2

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

Steve Kondik

ae271bc

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

[diff] [blame]

3

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

4

* *

5

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

6

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

7

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

8

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

9

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

10

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

11

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

12

* *

13

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

14

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

15

* *

16

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

17

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

18

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

19

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

20

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

21

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

22

* THE USE OR OTHER DEALINGS IN THE SOFTWARE. *

23

* *

24

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

25

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

26

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

27

* authorization. *

28

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

Steve Kondik

ae271bc

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

[diff] [blame]

29

* @Id: panel.3x,v 1.18 2015/04/11 10:23:49 tom Exp @

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

30

-->

Steve Kondik

ae271bc

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

[diff] [blame]

31

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

32

<HTML>

33

<HEAD>

Steve Kondik

ae271bc

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

[diff] [blame]

34

35

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

36

<TITLE>panel 3x</TITLE>

</HEAD>

<BODY>

Steve Kondik

ae271bc

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

[diff] [blame]

41

<H1 class="no-header">panel 3x</H1>

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

42

<PRE>

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

43

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

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

49

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

50

panel - panel stack extension for curses

51

52

53

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

54

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

55

#include <panel.h>

56

57

cc [flags] sourcefiles -lpanel -lncurses

58

59

PANEL *new_panel(WINDOW *win)

60

int bottom_panel(PANEL *pan)

61

int top_panel(PANEL *pan)

62

int show_panel(PANEL *pan)

63

void update_panels();

64

int hide_panel(PANEL *pan)

65

WINDOW *panel_window(const PANEL *pan)

66

int replace_panel(PANEL *pan, WINDOW *window)

67

int move_panel(PANEL *pan, int starty, int startx)

68

int panel_hidden(const PANEL *pan)

69

PANEL *panel_above(const PANEL *pan)

70

PANEL *panel_below(const PANEL *pan)

71

int set_panel_userptr(PANEL *pan, const void *ptr)

72

const void *panel_userptr(const PANEL *pan)

73

int del_panel(PANEL *pan)

74

75

76

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

77

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

78

Panels are <A HREF="ncurses.3x.html">curses(3x)</A> windows with the added feature of

79

depth. Panel functions allow the use of stacked windows

80

and ensure the proper portions of each window and the

81

curses stdscr window are hidden or displayed when panels

82

are added, moved, modified or removed. The set of cur-

83

rently visible panels is the stack of panels. The stdscr

84

window is beneath all panels, and is not considered part

85

of the stack.

86

87

A window is associated with every panel. The panel rou-

88

tines enable you to create, move, hide, and show panels,

89

as well as position a panel at any desired location in the

90

stack.

91

92

Panel routines are a functional layer added to <A HREF="ncurses.3x.html">curses(3x)</A>,

93

make only high-level curses calls, and work anywhere ter-

minfo curses does.

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

98

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

99

new_panel(win)

100

allocates a PANEL structure, associates it with

101

win, places the panel on the top of the stack

102

(causes it to be displayed above any other

103

panel) and returns a pointer to the new panel.

104

105

update_panels()

106

refreshes the virtual screen to reflect the rela-

107

tions between the panels in the stack, but does not

108

call doupdate() to refresh the physical screen.

Steve Kondik

ae271bc

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

[diff] [blame]

109

Use this function and not wrefresh or wnoutrefresh.

110

update_panels may be called more than once before a

111

call to doupdate(), but doupdate() is the function

112

responsible for updating the physical screen.

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

113

114

del_panel(pan)

115

removes the given panel from the stack and deallo-

Steve Kondik

ae271bc

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

[diff] [blame]

116

cates the PANEL structure (but not its associated

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

117

window).

118

119

hide_panel(pan)

Steve Kondik

ae271bc

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

[diff] [blame]

120

removes the given panel from the panel stack and

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

121

thus hides it from view. The PANEL structure is not

122

lost, merely removed from the stack.

123

124

panel_hidden(pan)

Steve Kondik

ae271bc

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

[diff] [blame]

125

returns TRUE if the panel is in the panel stack,

126

FALSE if it is not. If the panel is a null

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

127

pointer, return ERR.

128

129

show_panel(pan)

Steve Kondik

ae271bc

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

[diff] [blame]

130

makes a hidden panel visible by placing it on top

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

131

of the panels in the panel stack. See COMPATIBILITY

132

below.

133

134

top_panel(pan)

Steve Kondik

ae271bc

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

[diff] [blame]

135

puts the given visible panel on top of all panels

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

136

in the stack. See COMPATIBILITY below.

137

138

bottom_panel(pan)

139

puts panel at the bottom of all panels.

140

141

move_panel(pan,starty,startx)

142

moves the given panel window so that its upper-left

Steve Kondik

ae271bc

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

[diff] [blame]

143

corner is at starty, startx. It does not change

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

144

the position of the panel in the stack. Be sure to

Steve Kondik

ae271bc

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

[diff] [blame]

145

use this function, not mvwin(), to move a panel

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

146

window.

147

148

replace_panel(pan,window)

Steve Kondik

ae271bc

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

[diff] [blame]

149

replaces the current window of panel with window

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

150

(useful, for example if you want to resize a panel;

151

if you're using ncurses, you can call replace_panel

Steve Kondik

ae271bc

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

[diff] [blame]

152

on the output of <A HREF="wresize.3x.html">wresize(3x)</A>). It does not change

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

153

the position of the panel in the stack.

154

155

panel_above(pan)

Steve Kondik

ae271bc

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

[diff] [blame]

156

returns a pointer to the panel above pan. If the

157

panel argument is (PANEL *)0, it returns a pointer

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

158

to the bottom panel in the stack.

159

160

panel_below(pan)

Steve Kondik

ae271bc

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

[diff] [blame]

161

returns a pointer to the panel just below pan. If

162

the panel argument is (PANEL *)0, it returns a

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

163

pointer to the top panel in the stack.

164

165

set_panel_userptr(pan,ptr)

166

sets the panel's user pointer.

167

168

panel_userptr(pan)

169

returns the user pointer for a given panel.

170

171

panel_window(pan)

172

returns a pointer to the window of the given panel.

173

174

175

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

176

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

177

Each routine that returns a pointer returns NULL if an

178

error occurs. Each routine that returns an int value

179

returns OK if it executes successfully and ERR if not.

180

181

182

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

183

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

184

Reasonable care has been taken to ensure compatibility

185

with the native panel facility introduced in SVr3.2

Steve Kondik

ae271bc

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

[diff] [blame]

186

(inspection of the SVr4 manual pages suggests the program-

187

ming interface is unchanged). The PANEL data structures

188

are merely similar. The programmer is cautioned not to

189

directly use PANEL fields.

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

190

191

The functions show_panel() and top_panel() are identical

192

in this implementation, and work equally well with dis-

193

played or hidden panels. In the native System V implemen-

194

tation, show_panel() is intended for making a hidden panel

195

visible (at the top of the stack) and top_panel() is

196

intended for making an already-visible panel move to the

197

top of the stack. You are cautioned to use the correct

198

function to ensure compatibility with native panel

libraries.

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

203

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

204

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

205

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

206

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

error).

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

211

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

212

panel.h interface for the panels library

213

214

libpanel.a the panels library itself

215

216

217

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

218

219

<A HREF="ncurses.3x.html">curses(3x)</A>, <A HREF="curs_variables.3x.html">curs_variables(3x)</A>,

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

220

Steve Kondik

ae271bc

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

[diff] [blame]

221

This describes ncurses version 6.0 (patch 20150808).

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

222

223

224

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

225

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

226

Originally written by Warren Tucker <wht@n4hgf.mt-

227

park.ga.us>, primarily to assist in porting u386mon to

228

systems without a native panels library. Repackaged for

229

ncurses by Zeyd ben-Halim.

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

234

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

<ul>

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

239

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

240

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

241

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

242

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

243

244

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

245

246

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

247

</ul>

248

</div>

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

249

</BODY>

250

</HTML>