BPS Script API  2.24.4
bps::Brush Class Reference

A wrapper for QBrush. More...

Public Types

enum  BrushStyle {
  NoBrush = 0 , SolidPattern = 1 , Dense1Pattern = 2 , Dense2Pattern = 3 , Dense3Pattern = 4 , Dense4Pattern = 5 , Dense5Pattern = 6 , Dense6Pattern = 7 , Dense7Pattern = 8 , HorPattern = 9 ,
  VerPattern = 10 , CrossPattern = 11 , BDiagPattern = 12 , FDiagPattern = 13 , DiagCrossPattern = 14 , TexturePattern = 24
}
 Brush styles. More...
 

Public Member Functions

 Brush ()
 Default constructor.
 
String toString () const
 

Properties

Color color
 The brush color. More...
 
BrushStyle style
 The brush style. More...
 
Pixmap texture
 The brush texture pixmap. More...
 

Detailed Description

A wrapper for QBrush.

Example use within a report:

// change rectangle brush
var b = section.item('rect').brush; // copy current
b.color = new bps.Color(200,100,20);
b.style = bps.Brush.VerPattern;
section.item('rect').brush = b; // set new brush
A wrapper for QBrush.
Definition: bps.Brush.js:16
@ VerPattern
Vertical lines.
Definition: bps.Brush.js:47
A wrapper for QColor.
Definition: bps.Color.js:13
The bps extension is a namespace assembling general BPS properties and functions.
Definition: bps.AsyncIO.js:1

Member Enumeration Documentation

◆ BrushStyle

Brush styles.

Enumerator
NoBrush 

No brush pattern.

SolidPattern 

Uniform color.

Dense1Pattern 

Extremely dense brush pattern.

Dense2Pattern 

Very dense brush pattern.

Dense3Pattern 

Somewhat dense brush pattern.

Dense4Pattern 

Half dense brush pattern.

Dense5Pattern 

Somewhat sparse brush pattern.

Dense6Pattern 

Very sparse brush pattern.

Dense7Pattern 

Extremely sparse brush pattern.

HorPattern 

Horizontal lines.

VerPattern 

Vertical lines.

CrossPattern 

Crossing horizontal and vertical lines.

BDiagPattern 

Backward diagonal lines.

FDiagPattern 

Forward diagonal lines.

DiagCrossPattern 

Crossing diagonal lines.

TexturePattern 

Custom pattern (see texture).

Member Function Documentation

◆ toString()

String bps::Brush::toString ( ) const
Returns
Returns "Brush"

Property Documentation

◆ color

Color bps::Brush::color
readwrite

The brush color.

 

◆ style

BrushStyle bps::Brush::style
readwrite

The brush style.

 

◆ texture

Pixmap bps::Brush::texture
readwrite

The brush texture pixmap.

 


The documentation for this class was generated from the following file: