xref: /illumos-gate/usr/src/man/man3xcurses/hline.3xcurses (revision eb00b1c8a31c2253a353644606388dff5b0e0275)
te
Copyright (c) 1990, 1995 by Mortice Kern Systems Inc. All Rights Reserved Portions Copyright (c) 1996, Sun Microsystems, Inc. All Rights Reserved
The contents of this file are subject to the terms of the Common Development and Distribution License (the "License"). You may not use this file except in compliance with the License.
You can obtain a copy of the license at usr/src/OPENSOLARIS.LICENSE or http://www.opensolaris.org/os/licensing. See the License for the specific language governing permissions and limitations under the License.
When distributing Covered Code, include this CDDL HEADER in each file and include the License file at usr/src/OPENSOLARIS.LICENSE. If applicable, add the following below this CDDL HEADER, with the fields enclosed by brackets "[]" replaced with your own identifying information: Portions Copyright [yyyy] [name of copyright owner]
HLINE 3XCURSES "Jun 5, 2002"
NAME
hline, mvhline, mvvline, mvwhline, mvwvline, vline, whline, wvline - use single-byte characters (and renditions) to draw lines
SYNOPSIS

cc [ flag... ] file... -I /usr/xpg4/include  -L  /usr/xpg4/lib \e
 -R  /usr/xpg4/lib  -lcurses  [ library... ]

c89 [ flag... ] file... -lcurses [ library... ]

#include <curses.h>

int hline(chtype ch, int n);

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

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

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

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

int vline(chtype ch, int n);

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

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

The hline(), vline(), whline(), wvline() functions draw a horizontal or vertical line, in either the window stdscr or win starting at the current cursor position. The line is drawn using the character ch and is a maximum of n positions long, or as many as will fit into the window. If ch is 0 (zero), the default horizontal or vertical character is used.

The mvhline(), mvvline(), mvwhline(), mvwvline() functions are similar to the previous group of functions but the line begins at cursor position specified by x and y.

The functions with names ending with hline() draw horizontal lines proceeding towards the last column of the same line. The functions with names ending with vline() draw vertical lines proceeding towards the last column of the same line.

These functions do not change the position of the cursor.

PARAMETERS
ch

Is the character used to draw the line.

n

Is the maximum number of characters in the line.

y

Is the y (row) coordinate for the start of the line.

x

Is the x (column) coordinate for the start of the line.

win

Is a pointer to a window.

RETURN VALUES

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

ERRORS

None

ATTRIBUTES

See attributes(5) for descriptions of the following attributes:

ATTRIBUTE TYPE ATTRIBUTE VALUE
Interface Stability Standard
MT-Level Unsafe
SEE ALSO

border(3XCURSES), border_set(3XCURSES), hline_set(3XCURSES), libcurses(3XCURSES), attributes(5), standards(5)