whline_set(3xcurses)

1hline_set(3XCURSES)     X/Open Curses Library Functions    hline_set(3XCURSES)
2
3
4

NAME

6       hline_set,   mvhline_set,   mvvline_set,   mvwhline_set,  mvwvline_set,
7       vline_set, whline_set, wvline_set - use complex characters (and  rendi‐
8       tions) to draw lines
9

SYNOPSIS

11       cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \
12        -R  /usr/xpg4/lib  -lcurses  [ library... ]
13
14       c89 [ flag... ] file... -lcurses [ library... ]
15
16       #include <curses.h>
17
18       int hline_set(const cchar_t *ch, int n);
19
20
21       int mvhline_set(int y, int x, const cchar_t *wch, int n);
22
23
24       int mvvline_set(int y, int x, const cchar_t *wch, int n);
25
26
27       int mvwhline_set(WINDOW *win, int y, int x, const cchar_t *wch, int n);
28
29
30       int mvwvline_set(WINDOW *win, int y, int x, const cchar_t *wch, int n);
31
32
33       int vline_set(const cchar_t *wch, int n);
34
35
36       int whline_set(WINDOW *win, const cchar_t *wch, int n);
37
38
39       int wvline_set(WINDOW *win, const cchar_t *wch, int n);
40
41

DESCRIPTION

43       The  hline_set(),  vline_set(),  whline_set(),   wvline_set() functions
44       draw a line, in either the window stdscr  or win  starting at the  cur‐
45       rent  cursor position. The line is drawn using the character wch and is
46       a maximum of n positions long, or as many as will fit into the  window.
47       If  wch is a null pointer, the default horizontal or vertical character
48       is used.
49
50
51       The mvhline_set(), mvvline_set(), mvwhline_set(),  mvwvline_set() func‐
52       tions  are  similar  to  the  previous group of functions  but the line
53       begins at cursor position specified by x and y.
54
55
56       The functions with names ending with hline_set() draw horizontal  lines
57       proceeding towards the last column of the same line. The functions with
58       names ending with vline_set() draw vertical  lines  proceeding  towards
59       the last column of the same line.
60
61
62       These functions do not change the position of the cursor.
63

PARAMETERS

65       wch    Is the complex character used to draw the line.
66
67
68       n      Is the maximum number of characters in the line.
69
70
71       y      Is the y (row) coordinate for the start of the line.
72
73
74       x      Is the x (column) coordinate for the start of the line.
75
76
77       win    Is a pointer to a window.
78
79

RETURN VALUES

81       On success, these functions return OK. Otherwise, they return ERR.
82

ERRORS

84       None.
85

ATTRIBUTES

87       See attributes(5) for descriptions of the following attributes:
88
89
90
91
92       ┌─────────────────────────────┬─────────────────────────────┐
93       │      ATTRIBUTE TYPE         │      ATTRIBUTE VALUE        │
94       ├─────────────────────────────┼─────────────────────────────┤
95       │Interface Stability          │Standard                     │
96       ├─────────────────────────────┼─────────────────────────────┤
97       │MT-Level                     │Unsafe                       │
98       └─────────────────────────────┴─────────────────────────────┘
99