TdkTextStyle Class Reference
[The Core Module, The Core Module]

Defines the TdkTextStyle class. More...

#include <TdkTextStyle.h>

Inheritance diagram for TdkTextStyle:

List of all members.

Public Member Functions
	TdkTextStyle ()
	Constructor.
virtual	~TdkTextStyle ()
	Virtual Destructor.
virtual TdkTextStyle *	copy ()
	Copy a TdkTextStyle Object.
void	subtype (TdkTextType subtype)
	Set the Tdk Text type.
TdkTextType	subtype ()
	Returns the Tdk Text type.
void	foreColor (const TeColor &c)
	Set Text fore Color.
TeColor &	foreColor ()
	Returns the text fore color value.
void	backColor (const TeColor &c)
	Set the text back color.
TeColor &	backColor ()
	Returns back color value.
void	transparency (int transp)
	Set transparency value.
int	transparency ()
	Returns the transparency value.
void	backTransparency (int transp)
	Set the transparency background of text.
int	backTransparency ()
	Returns the background transparency value.
void	fixedColor (bool fixColor)
bool	fixedColor ()
void	fontName (string fontName)
	Set the font name.
string	fontName ()
	Returns the font name.
void	fontSize (double size)
	Set the font size.
double	fontSize ()
	Returns the font size.
void	fontStyle (TdkFontStyle fontStyle)
	Set the font style.
TdkFontStyle	fontStyle ()
	Return the font style.
void	underLine (bool underLine)
	Set under line for text.
bool	underLine ()
	Return the under line for text.
void	upperCase (bool upperCase)
	Set all character to upper case.
bool	upperCase ()
	Return if text is upper case.
void	horzAlignment (TdkHorzAlignment horz)
	Set the horizontal aligment.
TdkHorzAlignment	horzAlignment ()
	Returns the horizontal aligment.
void	vertAlignment (TdkVertAlignment vert)
	Set the vertical aligment.
TdkVertAlignment	vertAlignment ()
	Returns the vertical aligment.
void	offsetX (const double &dx)
	Set displacement on axle X.
double	offsetX ()
	Returns the displacement on axle X.
void	offsetY (const double &dy)
	Set displacement on axle Y.
double	offsetY ()
	Returns the displacement on axle Y.
void	fixedSize (bool status)
	Set if text size is fixed.
bool	fixedSize ()
	Return if text size is fixed.
virtual bool	autoDraw ()=0
	Auto Draw the text.
virtual void	draw (TdkCanvas *canvas, TeText &text, TeColor &externColor, double externWidthFactor)=0
	Draw Text.
virtual void	drawSample (TdkCanvas *canvas, int x, int y, TeColor &externColor)=0
	Draw Sample Text.
virtual bool	toBlob (TdkBlob *blob)
virtual bool	load (TdkBlob *blob, TdkStyleVersion version=TeCurrentStyleVer)
virtual int	getBlobSize ()
	Returns the size of the style in blob format.
	TdkTextStyle ()
	Constructor.
virtual	~TdkTextStyle ()
	Virtual Destructor.
virtual TdkTextStyle *	copy ()
	Copy a TdkTextStyle Object.
void	setSubtype (int subtype)
	Set the Tdk Text type.
int	getSubtype ()
	Returns the Tdk Text type.
void	setForeColor (const TeColor &c)
	Set Text fore Color.
TeColor &	getForeColor ()
	Returns the text fore color value.
void	setBackColor (const TeColor &c)
	Set the text back color.
TeColor &	getBackColor ()
	Returns back color value.
void	setTransparency (int transp)
	Set transparency value.
int	getTransparency ()
	Returns the transparency value.
void	setBackTransparency (int transp)
	Set the transparency background of text.
int	getBackTransparency ()
	Returns the background transparency value.
void	setFixedColor (bool fixColor)
bool	getFixedColor ()
void	setFontName (string fontName)
	Set the font name.
string	getFontName ()
	Returns the font name.
void	setFontSize (double size)
	Set the font size.
double	getFontSize ()
	Returns the font size.
void	setFontStyle (TdkFontStyle fontStyle)
	Set the font style.
TdkFontStyle	getFontStyle ()
	Return the font style.
void	setUnderLine (bool underLine)
	Set under line for text.
bool	getUnderLine ()
	Return the under line for text.
void	setUpperCase (bool upperCase)
	Set all character to upper case.
bool	getUpperCase ()
	Return if text is upper case.
void	setHorzAlignment (TdkHorzAlignment horz)
	Set the horizontal aligment.
TdkHorzAlignment	getHorzAlignment ()
	Returns the horizontal aligment.
void	setVertAlignment (TdkVertAlignment vert)
	Set the vertical aligment.
TdkVertAlignment	getVertAlignment ()
	Returns the vertical aligment.
void	setOffsetX (const double &dx)
	Set displacement on axle X.
double	getOffsetX ()
	Returns the displacement on axle X.
void	setOffsetY (const double &dy)
	Set displacement on axle Y.
double	getOffsetY ()
	Returns the displacement on axle Y.
void	setFixedSize (bool status)
	Set if text size is fixed.
bool	getFixedSize ()
	Return if text size is fixed.
virtual bool	autoDraw ()=0
	Auto Draw the text.
virtual bool	toBlob (TdkBlob *blob)
	Draw Sample Text.
virtual bool	load (TdkBlob *blob, TdkStyleVersion version=TeCurrentStyleVer)
virtual int	getBlobSize ()
	Returns the size of the style in blob format.
Protected Attributes
string	_fontName
	Font Name value.
double	_fontSize
	Font Size value.
TeColor	_foreColor
	Font Color value.
TeColor	_backColor
	BackGround Color value.
TdkFontStyle	_fontStyle
	Font Style value.
bool	_underLine
	Set text with under line.
bool	_upperCase
	Set text to display upper case.
TdkHorzAlignment	_horAlignment
	Horizontal Aligment value.
TdkVertAlignment	_vertAlignment
	Vertical Aligment value.
int	_transparency
	Transparency value.
int	_backTransparency
	Background transparency value.
double	_offset
	Displacement value.
TdkTextType	_subType
bool	_fixedColor
bool	_fixedSize
double	_offsetX
double	_offsetY
int	_subType

---

Detailed Description

Defines the TdkTextStyle class.

---

Constructor & Destructor Documentation

TdkTextStyle::TdkTextStyle

(

)

Constructor.

TdkTextStyle::~TdkTextStyle

(

)

[virtual]

Virtual Destructor.

TdkTextStyle::TdkTextStyle

(

)

Constructor.

virtual TdkTextStyle::~TdkTextStyle

(

)

[virtual]

Virtual Destructor.

---

Member Function Documentation

TdkTextStyle * TdkTextStyle::copy

(

)

[virtual]

Copy a TdkTextStyle Object.

Implements TdkStyle.

void TdkTextStyle::subtype

(

TdkTextType

subtype

)

Set the Tdk Text type.

Parameters:

subtype

text type

TdkTextType TdkTextStyle::subtype

(

)

Returns the Tdk Text type.

Returns:

returns the tdk text text

void TdkTextStyle::foreColor

(

const TeColor &

c

)

Set Text fore Color.

Parameters:

c

text color value

TeColor & TdkTextStyle::foreColor

(

)

Returns the text fore color value.

void TdkTextStyle::backColor

(

const TeColor &

c

)

Set the text back color.

Parameters:

c

back color value

TeColor & TdkTextStyle::backColor

(

)

Returns back color value.

void TdkTextStyle::transparency

(

int

transp

)

Set transparency value.

Parameters:

transp

transparence value

int TdkTextStyle::transparency

(

)

Returns the transparency value.

Returns:

returns the transparency value

void TdkTextStyle::backTransparency

(

int

transp

)

Set the transparency background of text.

int TdkTextStyle::backTransparency

(

)

Returns the background transparency value.

void TdkTextStyle::fixedColor

(

bool

fixColor

)

bool TdkTextStyle::fixedColor

(

)

void TdkTextStyle::fontName

(

string

fontName

)

Set the font name.

string TdkTextStyle::fontName

(

)

Returns the font name.

void TdkTextStyle::fontSize

(

double

size

)

Set the font size.

double TdkTextStyle::fontSize

(

)

Returns the font size.

void TdkTextStyle::fontStyle

(

TdkFontStyle

fontStyle

)

Set the font style.

Set the font style as Normal Italic Bold Italic/Bold

TdkFontStyle TdkTextStyle::fontStyle

(

)

Return the font style.

void TdkTextStyle::underLine

(

bool

underLine

)

Set under line for text.

bool TdkTextStyle::underLine

(

)

Return the under line for text.

void TdkTextStyle::upperCase

(

bool

upperCase

)

Set all character to upper case.

bool TdkTextStyle::upperCase

(

)

Return if text is upper case.

void TdkTextStyle::horzAlignment

(

TdkHorzAlignment

horz

)

Set the horizontal aligment.

Horizontal Aligment Left Center Right

TdkHorzAlignment TdkTextStyle::horzAlignment

(

)

Returns the horizontal aligment.

void TdkTextStyle::vertAlignment

(

TdkVertAlignment

vert

)

Set the vertical aligment.

Vertical Aligment Top Center Bottom

TdkVertAlignment TdkTextStyle::vertAlignment

(

)

Returns the vertical aligment.

void TdkTextStyle::offsetX

(

const double &

dx

)

Set displacement on axle X.

double TdkTextStyle::offsetX

(

)

Returns the displacement on axle X.

void TdkTextStyle::offsetY

(

const double &

dy

)

Set displacement on axle Y.

double TdkTextStyle::offsetY

(

)

Returns the displacement on axle Y.

void TdkTextStyle::fixedSize

(

bool

status

)

Set if text size is fixed.

bool TdkTextStyle::fixedSize

(

)

Return if text size is fixed.

virtual bool TdkTextStyle::autoDraw

(

)

[pure virtual]

Auto Draw the text.

Implemented in TdkTextStyleBasic, TdkTextStyleBitmap, TdkTextStyleImage, TdkTextStyleShadowed, TdkTextStyleBlock, TdkTextStyleShear, TdkTextStyleHallow, TkdTextStyleReflected, TdkTextStylePath, TdkTextStyleComposite, TdkTextStyleBasic, TdkTextStyleBitmap, TdkTextStyleBlock, TdkTextStyleComposite, TdkTextStyleHallow, TdkTextStyleImage, TdkTextStylePath, TdkTextStyleReflected, TdkTextStyleShadowed, and TdkTextStyleShear.

virtual void TdkTextStyle::draw	(	TdkCanvas *	canvas,
		TeText &	text,
		TeColor &	externColor,
		double	externWidthFactor
	)			[pure virtual]

Draw Text.

Draw text with tdk canvas

Parameters:

	canvas	Tdk Canvas
	text	text to draw
	externColor	extern color

Implemented in TdkTextStyleBasic, TdkTextStyleBitmap, TdkTextStyleImage, TdkTextStyleShadowed, TdkTextStyleBlock, TdkTextStyleShear, TdkTextStyleHallow, TkdTextStyleReflected, TdkTextStylePath, and TdkTextStyleComposite.

virtual void TdkTextStyle::drawSample	(	TdkCanvas *	canvas,
		int	x,
		int	y,
		TeColor &	externColor
	)			[pure virtual]

Draw Sample Text.

Draw Sample Text in Dialog text

Implemented in TdkTextStyleBasic, TdkTextStyleBitmap, TdkTextStyleImage, TdkTextStyleShadowed, TdkTextStyleBlock, TdkTextStyleShear, TdkTextStyleHallow, TkdTextStyleReflected, TdkTextStylePath, and TdkTextStyleComposite.

bool TdkTextStyle::toBlob

(

TdkBlob *

blob

)

[virtual]

Implements TdkStyle.

Reimplemented in TdkTextStyleShadowed, TdkTextStyleBlock, TdkTextStyleHallow, TdkTextStyleComposite, TdkTextStyleBlock, TdkTextStyleComposite, TdkTextStyleHallow, and TdkTextStyleShadowed.

bool TdkTextStyle::load	(	TdkBlob *	blob,
		TdkStyleVersion	version = TeCurrentStyleVer
	)			[virtual]

Implements TdkStyle.

Reimplemented in TdkTextStyleShadowed, TdkTextStyleBlock, TdkTextStyleHallow, TdkTextStyleComposite, TdkTextStyleBlock, TdkTextStyleComposite, TdkTextStyleHallow, and TdkTextStyleShadowed.

int TdkTextStyle::getBlobSize

(

)

[virtual]

Returns the size of the style in blob format.

Implements TdkStyle.

Reimplemented in TdkTextStyleShadowed, TdkTextStyleBlock, TdkTextStyleHallow, TdkTextStyleComposite, TdkTextStyleBlock, TdkTextStyleComposite, TdkTextStyleHallow, and TdkTextStyleShadowed.

virtual TdkTextStyle* TdkTextStyle::copy

(

)

[virtual]

Copy a TdkTextStyle Object.

Implements TdkStyle.

void TdkTextStyle::setSubtype

(

int

subtype

)

[inline]

Set the Tdk Text type.

Parameters:

subtype

text type

int TdkTextStyle::getSubtype

(

)

[inline]

Returns the Tdk Text type.

Returns:

returns the tdk text text

void TdkTextStyle::setForeColor

(

const TeColor &

c

)

[inline]

Set Text fore Color.

Parameters:

c

text color value

TeColor & TdkTextStyle::getForeColor

(

)

[inline]

Returns the text fore color value.

void TdkTextStyle::setBackColor

(

const TeColor &

c

)

[inline]

Set the text back color.

Parameters:

c

back color value

TeColor & TdkTextStyle::getBackColor

(

)

[inline]

Returns back color value.

void TdkTextStyle::setTransparency

(

int

transp

)

[inline]

Set transparency value.

Parameters:

transp

transparence value

int TdkTextStyle::getTransparency

(

)

[inline]

Returns the transparency value.

Returns:

returns the transparency value

void TdkTextStyle::setBackTransparency

(

int

transp

)

[inline]

Set the transparency background of text.

int TdkTextStyle::getBackTransparency

(

)

[inline]

Returns the background transparency value.

void TdkTextStyle::setFixedColor

(

bool

fixColor

)

[inline]

bool TdkTextStyle::getFixedColor

(

)

[inline]

void TdkTextStyle::setFontName

(

string

fontName

)

[inline]

Set the font name.

string TdkTextStyle::getFontName

(

)

[inline]

Returns the font name.

void TdkTextStyle::setFontSize

(

double

size

)

[inline]

Set the font size.

double TdkTextStyle::getFontSize

(

)

[inline]

Returns the font size.

void TdkTextStyle::setFontStyle

(

TdkFontStyle

fontStyle

)

[inline]

Set the font style.

Set the font style as Normal Italic Bold Italic/Bold

TdkFontStyle TdkTextStyle::getFontStyle

(

)

[inline]

Return the font style.

void TdkTextStyle::setUnderLine

(

bool

underLine

)

[inline]

Set under line for text.

bool TdkTextStyle::getUnderLine

(

)

[inline]

Return the under line for text.

void TdkTextStyle::setUpperCase

(

bool

upperCase

)

[inline]

Set all character to upper case.

bool TdkTextStyle::getUpperCase

(

)

[inline]

Return if text is upper case.

void TdkTextStyle::setHorzAlignment

(

TdkHorzAlignment

horz

)

[inline]

Set the horizontal aligment.

Horizontal Aligment Left Center Right

TdkHorzAlignment TdkTextStyle::getHorzAlignment

(

)

[inline]

Returns the horizontal aligment.

void TdkTextStyle::setVertAlignment

(

TdkVertAlignment

vert

)

[inline]

Set the vertical aligment.

Vertical Aligment Top Center Bottom

TdkVertAlignment TdkTextStyle::getVertAlignment

(

)

[inline]

Returns the vertical aligment.

void TdkTextStyle::setOffsetX

(

const double &

dx

)

[inline]

Set displacement on axle X.

double TdkTextStyle::getOffsetX

(

)

[inline]

Returns the displacement on axle X.

void TdkTextStyle::setOffsetY

(

const double &

dy

)

[inline]

Set displacement on axle Y.

double TdkTextStyle::getOffsetY

(

)

[inline]

Returns the displacement on axle Y.

void TdkTextStyle::setFixedSize

(

bool

status

)

[inline]

Set if text size is fixed.

bool TdkTextStyle::getFixedSize

(

)

[inline]

Return if text size is fixed.

virtual bool TdkTextStyle::autoDraw

(

)

[pure virtual]

Auto Draw the text.

Implemented in TdkTextStyleBasic, TdkTextStyleBitmap, TdkTextStyleImage, TdkTextStyleShadowed, TdkTextStyleBlock, TdkTextStyleShear, TdkTextStyleHallow, TkdTextStyleReflected, TdkTextStylePath, TdkTextStyleComposite, TdkTextStyleBasic, TdkTextStyleBitmap, TdkTextStyleBlock, TdkTextStyleComposite, TdkTextStyleHallow, TdkTextStyleImage, TdkTextStylePath, TdkTextStyleReflected, TdkTextStyleShadowed, and TdkTextStyleShear.

virtual bool TdkTextStyle::toBlob

(

TdkBlob *

blob

)

[virtual]

Draw Sample Text.

Draw Sample Text in Dialog text

Implements TdkStyle.

Reimplemented in TdkTextStyleShadowed, TdkTextStyleBlock, TdkTextStyleHallow, TdkTextStyleComposite, TdkTextStyleBlock, TdkTextStyleComposite, TdkTextStyleHallow, and TdkTextStyleShadowed.

virtual bool TdkTextStyle::load	(	TdkBlob *	blob,
		TdkStyleVersion	version = TeCurrentStyleVer
	)			[virtual]

Implements TdkStyle.

Reimplemented in TdkTextStyleShadowed, TdkTextStyleBlock, TdkTextStyleHallow, TdkTextStyleComposite, TdkTextStyleBlock, TdkTextStyleComposite, TdkTextStyleHallow, and TdkTextStyleShadowed.

virtual int TdkTextStyle::getBlobSize

(

)

[virtual]

Returns the size of the style in blob format.

Implements TdkStyle.

Reimplemented in TdkTextStyleShadowed, TdkTextStyleBlock, TdkTextStyleHallow, TdkTextStyleComposite, TdkTextStyleBlock, TdkTextStyleComposite, TdkTextStyleHallow, and TdkTextStyleShadowed.

---

Member Data Documentation

string TdkTextStyle::_fontName [protected]

Font Name value.

double TdkTextStyle::_fontSize [protected]

Font Size value.

TeColor TdkTextStyle::_foreColor [protected]

Font Color value.

TeColor TdkTextStyle::_backColor [protected]

BackGround Color value.

TdkFontStyle TdkTextStyle::_fontStyle [protected]

Font Style value.

bool TdkTextStyle::_underLine [protected]

Set text with under line.

bool TdkTextStyle::_upperCase [protected]

Set text to display upper case.

TdkHorzAlignment TdkTextStyle::_horAlignment [protected]

Horizontal Aligment value.

TdkVertAlignment TdkTextStyle::_vertAlignment [protected]

Vertical Aligment value.

int TdkTextStyle::_transparency [protected]

Transparency value.

int TdkTextStyle::_backTransparency [protected]

Background transparency value.

double TdkTextStyle::_offset [protected]

Displacement value.

TdkTextType TdkTextStyle::_subType [protected]

bool TdkTextStyle::_fixedColor [protected]

bool TdkTextStyle::_fixedSize [protected]

double TdkTextStyle::_offsetX [protected]

double TdkTextStyle::_offsetY [protected]

int TdkTextStyle::_subType [protected]

---

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

• D:/usuarios/rodrigof/svn/tdk/src/peer/components/core/styles/TdkTextStyle.h
• D:/usuarios/rodrigof/svn/tdk/src/peer/components/core/styles/textstyles/TdkTextStyle.h
• D:/usuarios/rodrigof/svn/tdk/src/peer/components/core/styles/TdkTextStyle.cpp
• D:/usuarios/rodrigof/svn/tdk/src/peer/components/core/styles/textstyles/TdkTextStyle.cpp
• D:/usuarios/rodrigof/svn/tdk/src/peer/components/core/styles/textstyles/TdkTextStyle.inl

---