bg_linedef()

Defines a background line on a form

Call  
#include <vv_form.h>
BG_LINEPTR bg_linedef(wn_rb, wn_cb, len, dir, att, ln_stylep, fmp)

int wn_rb

Row of form window to begin line

int wn_cb Column of form window to begin line
int len Length of the line
int dir Direction of the line
UCHAR att Video attribute of the line
LINEPTR ln_stylep Line type
FORMPTR fmp Pointer to form to place line
Description of Parameters

dir: Specify UP, DOWN, LEFT, or RIGHT. These values can be bitwise or'ed with the modifiers X_LINE (to intersect with other lines and boxes) Intersections can only occur for single and double lines.

ln_stylep: Specify one of the following pre-defined line styles. Appearance is operating system dependent.

LINE_SLNP

Line using the single-line graphics characters

LINE_DLNP Line using the double-line graphics characters
LINE_SPACEP Line using the space character
LINE_DOTP Line using the stippled block graphics character or period
LINE_STARP Line using asterisks
LINE_SOLIDP Line using the solid block graphics character or space character
Returns  
POINTER A pointer to the background line structure.
NULLP Error. VV_ERR is set to the following:
  MEMLACK Insufficient memory is available to define a background line structure.  
Description

bg_linedef() allocates memory for a new node in the linked list of background items in the form structure. The node for this background line is inserted in the appropriate place in the linked list. The order of the nodes are maintained so that all scrollable region backgrounds are listed first, followed by lines, boxes, and text.

The members in the structure are initialized to the parameters specified in the call. Lines specified as having a direction of LEFT or UP are mapped to equivalent lines with a direction of RIGHT or DOWN, respectively.

Before defining an intersecting line with bg_linedef(), you should define the background lines that will intersect the line.

Cautions

To obtain the correct interconnecting characters, the intersecting line must be defined AFTER the item(s) to be intersected.

UNIX and VMS Systems:

Under VMS and non-memory mapped UNIX displays, the terminal must be set to block graphics mode before the line can be drawn. If you specify one of the Vermont Views system logical attributes, Vermont Views will set the terminal to block graphics mode. However, the attribute you specified will be ignored; the line will be displayed in normal video.

Related Functions

bg_boxdef(), bg_txtdef()


Home Contents Previous Next