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

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

2

<!--

3

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

4

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

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

30

* @Id: curs_border.3x,v 1.19 2007/02/24 16:15:38 tom Exp @

-->

<HTML>

<HEAD>

<TITLE>curs_border 3x</TITLE>

</HEAD>

<BODY>

<H1>curs_border 3x</H1>

40

<HR>

41

<PRE>

42

43

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

</PRE>

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

51

mvhline, mvwhline, mvvline, mvwvline - create curses

52

borders, horizontal and vertical lines

</PRE>

<H2>SYNOPSIS</H2><PRE>

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);

</PRE>

<H2>DESCRIPTION</H2><PRE>

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.

</PRE>

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

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-

125

mentation returns an error if the window pointer is null.

</PRE>

<H2>NOTES</H2><PRE>

The borders generated by these functions are inside bor-

131

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

132

not documented).

133

134

Note that border and box may be macros.

</PRE>

<H2>PORTABILITY</H2><PRE>

139

These functions are described in the XSI Curses standard,

140

Issue 4. The standard specifies that they return ERR on

141

failure, but specifies no error conditions.

</PRE>

<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>

</PRE>

<HR>

Man(1) output converted with

</ADDRESS>

</BODY>

</HTML>