PowerUI.Css.TextDecorationInfo Class Reference

Detailed Description

Info about a line drawn over some text.

Public Member Functions

 TextDecorationInfo (TextLineType type)
 Creates a new line of the given type. More...
 
void SetColour (Color colour)
 Sets a custom colour to this decoration. More...
 
void SetOverlayColour (Color colour)
 Applies the overlay colour. Only called when ColourOverride is true. More...
 

Public Attributes

Color Colour
 The colour of the line, with colour overlay applied. More...
 
Color BaseColour
 The colour of the line without overlay. More...
 
TextLineType Type
 The position of the line. More...
 
bool ColourOverride
 Is the line colour a custom one? Otherwise the font colour is used. More...
 

Constructor & Destructor Documentation

PowerUI.Css.TextDecorationInfo.TextDecorationInfo ( TextLineType  type)
inline

Creates a new line of the given type.

Member Function Documentation

void PowerUI.Css.TextDecorationInfo.SetColour ( Color  colour)
inline

Sets a custom colour to this decoration.

void PowerUI.Css.TextDecorationInfo.SetOverlayColour ( Color  colour)
inline

Applies the overlay colour. Only called when ColourOverride is true.

Member Data Documentation

Color PowerUI.Css.TextDecorationInfo.BaseColour

The colour of the line without overlay.

Color PowerUI.Css.TextDecorationInfo.Colour

The colour of the line, with colour overlay applied.

bool PowerUI.Css.TextDecorationInfo.ColourOverride

Is the line colour a custom one? Otherwise the font colour is used.

TextLineType PowerUI.Css.TextDecorationInfo.Type

The position of the line.