Index for Section 3

Alphabetical listing for C

Bottom of page

curs_border_set(3)
NAME
  curs_border_set, border_set, wborder_set, box_set, hline_set, whline_set,
  mvhline_set, mvwhline_set, vline_set, wvline_set, mvvline_set, mvwvline_set
  - Draw borders or lines by using complex characters and renditions

SYNOPSIS
  #include <curses.h>

  int border_set(
	  const cchar_t *ls,
	  const cchar_t *rs,
	  const cchar_t *ts,
	  const cchar_t *bs,
	  const cchar_t *tl,
	  const cchar_t *tr,
	  const cchar_t *bl,
	  const cchar_t *br );

  int wborder_set(
	  WINDOW *win,
	  const cchar_t *ls,
	  const cchar_t *rs,
	  const cchar_t *ts,
	  const cchar_t *bs,
	  const cchar_t *tl,
	  const cchar_t *tr,
	  const cchar_t *bl,
	  const cchar_t *br );

  int box_set(
	  WINDOW *win,
	  const cchar_t *verch,
	  const cchar_t *horch );

  int hline_set(
	  const cchar_t *wch,
	  int n );

  int whline_set(
	  WINDOW *win,
	  const cchar_t *wch,
	  int n );

  int mvhline_set(
	  int y,
	  int x,
	  const cchar_t *wch,
	  int n );

  int mvwhline_set(
	  WINDOW *win,
	  int y,
	  int x,
	  const cchar_t *wch,
	  int n );

  int vline_set(
	  const cchar_t *wch,
	  int n );

  int wvline_set(
	  WINDOW *win,
	  const cchar_t *wch,
	  int n );

  int mvvline_set(
	  int y,
	  int x,
	  const cchar_t *wch,
	  int n );

  int mvwvline_set(
	  WINDOW *win,
	  int y,
	  int x,
	  const cchar_t *wch,
	  int n );

LIBRARY
  Curses Library (libcurses)

STANDARDS
  Interfaces documented on this reference page conform to industry standards
  as follows:

  border_set, wborder_set, box_set, hline_set, whline_set, mvhline_set,
  mvwhline_set, vline_set, wvline_set, mvvline_set, mvwvline_set:  XCURSES4.2

  Refer to the standards(5) reference page for more information about
  industry standards and associated tags.

DESCRIPTION
  The border_set and wborder_set functions draw a border around the edges of
  the current or specified window.  These functions do not advance the cursor
  position, do not perform special character processing, and do not perform
  wrapping.

  The arguments in the left-hand column of the following table contain
  spacing complex characters with renditions, which have the specified uses
  in drawing the border:

  _______________________________________________________________
  Argument Name	  Usage				    Default Value
  _______________________________________________________________
  ls		  Starting-column side		    WACS_VLINE
  rs		  Ending-column side		    WACS_VLINE
  ts		  First-line side		    WACS_HLINE
  bs		  Last-line side		    WACS_HLINE
  tl						    WACS_ULCORNER

		  Corner of the first line and
		  the starting column
  tr						    WACS_URCORNER

		  Corner of the first line and
		  the ending column

  bl						    WACS_LLCORNER

		  Corner of the last line and the
		  starting column
  br						    WACS_LRCORNER

		  Corner of the last line and the
		  ending column
  _______________________________________________________________

  If the value of any argument in the left-hand column of the table is a null
  pointer, then the default value in the right-hand column is used. If the
  value of any argument in the left-hand column of the table is a multicolumn
  character, the results are undefined.

  The box_set function draws a border around the edges of the specified
  window. This function does not advance the cursor position, does not
  perform special-character processing, and does not perform wrapping.

  The call box_set(win, verch, horch); is equivalent to the following call:

       wborder_set(win, verch, verch,
	   horch, horch, NULL, NULL, NULL, NULL);

  The *line_set functions use wch to draw a line in the current or specified
  window, starting at the current or specified position. The line is at most
  n positions in length or as many positions as can fit into the window.
  These functions do not advance the cursor position, do not perform
  special-character processing, and do not perform wrapping.

  The hline_set, mvhline_set, mvwhline_set, and whline_set functions draw a
  line proceeding toward the last column of the same line.

  The vline_set, mvvline_set, mvwvline_set, and wvline_set functions draw a
  line proceeding toward the last line of the window.

NOTES
  The header file <curses.h> automatically includes the header file
  <stdio.h>.

  Note that border_set, hlines_set, mvhline_set, mvvline_set, mvwhline_set,
  mvwvline_set, and vline_set may be macros.

RETURN VALUES
  Upon successful completion, these functions return OK.  Otherwise, they
  return ERR.

SEE ALSO
  Functions: curses(3), curs_border(3), curs_outopts(3)

  Others: standards(5)

Index for Section 3

Alphabetical listing for C

Top of page