Blame - doc/html/man/curs_border.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: curs_border.3x,v 1.22 2010/12/04 18:36:44 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>curs_border 3x</TITLE>

</HEAD>

<BODY>

Steve Kondik

ae271bc

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

[diff] [blame]

41

<H1 class="no-header">curs_border 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="curs_border.3x.html">curs_border(3x)</A> <A HREF="curs_border.3x.html">curs_border(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

border, wborder, box, hline, whline, vline, wvline,

51

mvhline, mvwhline, mvvline, mvwvline - create curses

52

borders, horizontal and vertical lines

53

54

55

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

56

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

57

#include <curses.h>

58

int border(chtype ls, chtype rs, chtype ts, chtype bs,

59

chtype tl, chtype tr, chtype bl, chtype br);

60

int wborder(WINDOW *win, chtype ls, chtype rs,

61

chtype ts, chtype bs, chtype tl, chtype tr,

62

chtype bl, chtype br);

63

int box(WINDOW *win, chtype verch, chtype horch);

64

int hline(chtype ch, int n);

65

int whline(WINDOW *win, chtype ch, int n);

66

int vline(chtype ch, int n);

67

int wvline(WINDOW *win, chtype ch, int n);

68

int mvhline(int y, int x, chtype ch, int n);

69

int mvwhline(WINDOW *, int y, int x, chtype ch, int n);

70

int mvvline(int y, int x, chtype ch, int n);

71

int mvwvline(WINDOW *, int y, int x, chtype ch, int n);

72

73

74

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

75

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

76

The border, wborder and box routines draw a box around the

77

edges of a window. Other than the window, each argument

78

is a character with attributes:

ls - left side,

rs - right side,

ts - top side,

bs - bottom side,

tl - top left-hand corner,

85

tr - top right-hand corner,

86

bl - bottom left-hand corner, and

87

br - bottom right-hand corner.

88

89

If any of these arguments is zero, then the corresponding

90

default values (defined in curses.h) are used instead:

ACS_VLINE,

ACS_VLINE,

ACS_HLINE,

ACS_HLINE,

ACS_ULCORNER,

ACS_URCORNER,

ACS_LLCORNER,

ACS_LRCORNER.

box(win, verch, horch) is a shorthand for the following

102

call: wborder(win, verch, verch, horch, horch, 0, 0, 0,

103

0).

104

105

The hline and whline functions draw a horizontal (left to

106

right) line using ch starting at the current cursor posi-

107

tion in the window. The current cursor position is not

108

changed. The line is at most n characters long, or as

109

many as fit into the window.

110

111

The vline and wvline functions draw a vertical (top to

112

bottom) line using ch starting at the current cursor posi-

113

tion in the window. The current cursor position is not

114

changed. The line is at most n characters long, or as

115

many as fit into the window.

116

117

118

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

119

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

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

120

All routines return the integer OK. The SVr4.0 manual

121

says "or a non-negative integer if immedok is set", but

122

this appears to be an error.

123

124

X/Open does not define any error conditions. This imple-

Steve Kondik

ae271bc

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

[diff] [blame]

125

mentation returns an error if the window pointer is null.

126

127

Functions with a "mv" prefix first perform a cursor move-

128

ment using wmove, and return an error if the position is

129

outside the window, or if the window pointer is null.

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

130

131

132

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

133

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

134

The borders generated by these functions are inside bor-

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

135

ders (this is also true of SVr4 curses, though the fact is

136

not documented).

137

138

Note that border and box may be macros.

139

140

141

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

142

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

143

These functions are described in the XSI Curses standard,

144

Issue 4. The standard specifies that they return ERR on

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

145

failure, but specifies no error conditions.

146

147

148

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

149

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

150

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

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

155

</PRE>

Steve Kondik

ae271bc

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

[diff] [blame]

<ul>

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

160

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

161

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

162

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

163

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

164

165

</ul>

166

</div>

Amit Daniel Kachhap

e6a01f5

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

[diff] [blame]

167

</BODY>

168

</HTML>