Documents > BPS V2 Script API
bps::Color Class Reference

A wrapper for QColor. More...

List of all members.

Public Member Functions

 Color ()
 Default constructor.
 Color (Number aRed, Number aGreen, Number aBlue, Number aAlpha=255)
 Initializing constructor.
Number rgb () const
void setRgb (Number aRed, Number aGreen, Number aBlue, Number aAlpha=255)
 Set new RGBA values.
String toString () const

Properties

Number alpha
 The alpha transparency value in range 0...255.
Number blue
 The blue value in range 0...255.
Number green
 The green value in range 0...255.
Number red
 The red value in range 0...255.

Detailed Description

A wrapper for QColor.

Example use within a report:

 // change simple text color
 setion.item('myText').color = new bps.Color(50,100,150,128);

Constructor & Destructor Documentation

bps::Color::Color ( Number  aRed,
Number  aGreen,
Number  aBlue,
Number  aAlpha = 255 
)

Initializing constructor.

Parameters:
aRedThe red value in range 0...255.
aGreenThe green value in range 0...255.
aBlueThe blue value in range 0...255.
aAlphaThe alpha transparency value in range 0...255.

Member Function Documentation

Number bps::Color::rgb ( ) const
Returns:
A RGBA quadruplet on the format AARRGGBB, equivalent to an unsigned int.
void bps::Color::setRgb ( Number  aRed,
Number  aGreen,
Number  aBlue,
Number  aAlpha = 255 
)

Set new RGBA values.

Parameters:
aRedThe red value in range 0...255.
aGreenThe green value in range 0...255.
aBlueThe blue value in range 0...255.
aAlphaThe alpha transparency value in range 0...255.
String bps::Color::toString ( ) const
Returns:
Returns "Color(r,g,b,a)"

Property Documentation

Number bps::Color::alpha [read, write]

The alpha transparency value in range 0...255.

 

Number bps::Color::blue [read, write]

The blue value in range 0...255.

 

Number bps::Color::green [read, write]

The green value in range 0...255.

 

Number bps::Color::red [read, write]

The red value in range 0...255.