curses_line(3) - NetBSD Manual Pages

Command:
Section:
Arch:
Collection:
>>>
CURSES_LINE(3)          NetBSD Library Functions Manual         CURSES_LINE(3)


NAME

     curses_line, hline, whline, vline, wvline, mvhline, mvwhline, mvvline,
     mvwvline -- curses draw lines on windows routines


LIBRARY

     Curses Library (libcurses, -lcurses)


SYNOPSIS

     #include <curses.h>

     int
     hline(chtype ch, int n);

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

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

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

     int
     vline(chtype c, int n);

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

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

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


DESCRIPTION

     These functions draw lines on stdscr or on the specified window.

     The hline() function draws a horizontal line of the character ch on
     stdscr starting at the current cursor position and extending for n char-
     acters, or until the right hand side of stdscr is reached.  If the text
     portion of ch is 0 then the line will be drawn with the ACS_HLINE charac-
     ter.

     The whline() function is the same as the hline() function, excepting that
     the line is drawn in the window specified by win.

     The vline() function draws a vertical line of character ch on stdscr
     starting at the current cursor position and moving down until either n
     characters have been drawn or the bottom of stdscr is reached.  If the
     text portion of ch is 0 then the line will be drawn with the ACS_VLINE
     character.

     The wvline() function is the same as the vline() function, excepting that
     the line is drawn on the given window.

     The mvhline(), mvwhline(), mvvline() and mvwvline() functions are the
     same as the hline(), whline(), vline() and wvline() functions, respec-
     tively, excepting that wmove() is called to move the cursor to the posi-
     tion specified by y, x before the line is drawn on the window.


RETURN VALUES

     Functions returning pointers will return NULL if an error is detected.
     The functions that return an int will return one of the following values:

     OK   The function completed successfully.
     ERR  An error occurred in the function.


SEE ALSO

     curses_border(3)


STANDARDS

     The NetBSD Curses library complies with the X/Open Curses specification,
     part of the Single Unix Specification.

     The use of ACS_HLINE and ACS_VLINE as default drawing character in
     hline() and vline() is a NetBSD extension which should not be relied on
     in portable code.


HISTORY

     The Curses package appeared in 4.0BSD.

NetBSD 8.0                     February 19, 2010                    NetBSD 8.0