te::at::Attributes Class Reference

#include <Attributes.h>

Public Member Functions

 Attributes ()
 Text Attributes constructor. More...
 
 Attributes (const std::string &family, const double pointSize=10.0, FontStyle style=NormalStyle, FontWeight weight=NormalWeight, HorizontalAlignment ha=CenterH, VerticalAlignment va=Baseline)
 Text Attributes constructor. More...
 
 Attributes (const Attributes &rhs)
 Copy constructor. More...
 
TextDecoration getDecoration () const
 It returns the font decoration. More...
 
const std::string & getFamily () const
 It returns the font family. More...
 
HorizontalAlignment getHorizontalAlignment () const
 It returns the horizontal text alignment. More...
 
const double & getLetterSpacing () const
 It returns the letter spacing. More...
 
LineJustification getLineJustification () const
 It returns the multi line justification. More...
 
const double & getLineSpacing () const
 It returns the multi line spacing. More...
 
const double & getPointSize () const
 It returns the font point size. More...
 
FontStyle getStyle () const
 It returns the font style. More...
 
const std::string & getTextColor () const
 It returns the text color. More...
 
const double & getTextOpacity () const
 It returns the text opacity. More...
 
const std::string & getTextStrokeColor () const
 It returns the text stroke color. More...
 
const double & getTextStrokeOpacity () const
 It returns the text stroke opacity. More...
 
const double & getTextStrokeWidth () const
 It returns the text stroke width. More...
 
VerticalAlignment getVerticalAlignment () const
 It returns the vertical text alignment. More...
 
FontWeight getWeight () const
 It returns the font weight. More...
 
const double & getWordSpacing () const
 It returns the word spacing. More...
 
Attributesoperator= (const Attributes &rhs)
 Assignment operator. More...
 
void setDecoration (TextDecoration decoration)
 It sets the font decoration. More...
 
void setFamily (const std::string &family)
 It sets the font family. More...
 
void setHorizontalAlignment (HorizontalAlignment ha)
 It sets the horizontal text alignment. More...
 
void setLetterSpacing (const double &spacing)
 It sets the letter spacing. More...
 
void setLineJustification (LineJustification just)
 It sets the multi line justification. More...
 
void setLineSpacing (const double &spacing)
 It sets the multi line spacing. More...
 
void setPointSize (const double &ps)
 It sets the font point size. More...
 
void setStyle (FontStyle style)
 It sets the font style. More...
 
void setTextColor (const std::string &color)
 It sets the text color. More...
 
void setTextOpacity (double &opacity)
 It sets the text opacity. More...
 
void setTextStrokecolor (const std::string &color)
 It sets the text stroke color. More...
 
void setTextStrokeOpacity (const double &opacity)
 It sets the text stroke opacity. More...
 
void setTextStrokeWidth (const double &width)
 It sets the text stroke width. More...
 
void setVerticalAlignment (VerticalAlignment va)
 It sets the vertical text alignment. More...
 
void setWeight (FontWeight weight)
 It sets the font weight. More...
 
void setWordSpacing (const double &spacing)
 It sets the word spacing. More...
 
 ~Attributes ()
 Text Element destructor. More...
 

Private Attributes

TextDecoration m_decoration
 text decoration More...
 
std::string m_family
 font family More...
 
std::string m_fillColor
 text fill color More...
 
double m_fillOpacity
 text fill color opacity (0..1) More...
 
HorizontalAlignment m_hAlign
 horizontal text alignment More...
 
double m_letterSpacing
 letter spacing (0..1) More...
 
LineJustification m_multiLineJustification
 multi line justufucation More...
 
double m_multiLineSpacing
 multi line spacing More...
 
double m_pointSize
 font point size More...
 
std::string m_strokeColor
 text stroke color More...
 
double m_strokeOpacity
 text stroke color opacity (0..1) More...
 
double m_strokeWidth
 text stroke width (0..1) More...
 
FontStyle m_style
 font style More...
 
VerticalAlignment m_vAlign
 vertical text alignment More...
 
FontWeight m_weight
 font weight More...
 
double m_wordSpacing
 word spacing (0..1) More...
 

Detailed Description

Definition at line 52 of file Attributes.h.

Constructor & Destructor Documentation

te::at::Attributes::Attributes ( )

Text Attributes constructor.

te::at::Attributes::Attributes ( const std::string &  family,
const double  pointSize = 10.0,
FontStyle  style = NormalStyle,
FontWeight  weight = NormalWeight,
HorizontalAlignment  ha = CenterH,
VerticalAlignment  va = Baseline 
)

Text Attributes constructor.

Parameters
familyThe font family.
pointSizeThe font point size
styleThe font style.
weightThe font weight.
haThe text horizontal alignment.
vaThe text vertical alignment.
te::at::Attributes::Attributes ( const Attributes rhs)

Copy constructor.

Parameters
rhsThe right-hand-side copy that would be used to copy from.
te::at::Attributes::~Attributes ( )

Text Element destructor.

Member Function Documentation

TextDecoration te::at::Attributes::getDecoration ( ) const

It returns the font decoration.

Returns
The font decoration.
const std::string& te::at::Attributes::getFamily ( ) const

It returns the font family.

Returns
The font family.
HorizontalAlignment te::at::Attributes::getHorizontalAlignment ( ) const

It returns the horizontal text alignment.

Returns
The horizontal text alignment.
const double& te::at::Attributes::getLetterSpacing ( ) const

It returns the letter spacing.

Returns
The letter spacing.
LineJustification te::at::Attributes::getLineJustification ( ) const

It returns the multi line justification.

Returns
The multi line justification.
const double& te::at::Attributes::getLineSpacing ( ) const

It returns the multi line spacing.

Returns
The multi line spacing.
const double& te::at::Attributes::getPointSize ( ) const

It returns the font point size.

Returns
The font point size.
FontStyle te::at::Attributes::getStyle ( ) const

It returns the font style.

Returns
The font style.
const std::string& te::at::Attributes::getTextColor ( ) const

It returns the text color.

Returns
The text color.
const double& te::at::Attributes::getTextOpacity ( ) const

It returns the text opacity.

Returns
The text opacity.
const std::string& te::at::Attributes::getTextStrokeColor ( ) const

It returns the text stroke color.

Returns
The text stroke color.
const double& te::at::Attributes::getTextStrokeOpacity ( ) const

It returns the text stroke opacity.

Returns
The text stroke opacity.
const double& te::at::Attributes::getTextStrokeWidth ( ) const

It returns the text stroke width.

Returns
The text stroke width.
VerticalAlignment te::at::Attributes::getVerticalAlignment ( ) const

It returns the vertical text alignment.

Returns
The vertical text alignment.
FontWeight te::at::Attributes::getWeight ( ) const

It returns the font weight.

Returns
The font weight.
const double& te::at::Attributes::getWordSpacing ( ) const

It returns the word spacing.

Returns
The word spacing.
Attributes& te::at::Attributes::operator= ( const Attributes rhs)

Assignment operator.

Parameters
rhsThe right-hand-side copy that would be used to copy from.
void te::at::Attributes::setDecoration ( TextDecoration  decoration)

It sets the font decoration.

Parameters
decorationThe font decoration.
void te::at::Attributes::setFamily ( const std::string &  family)

It sets the font family.

Parameters
familyThe font family.
void te::at::Attributes::setHorizontalAlignment ( HorizontalAlignment  ha)

It sets the horizontal text alignment.

Parameters
haThe horizontal text alignment.
void te::at::Attributes::setLetterSpacing ( const double &  spacing)

It sets the letter spacing.

Parameters
spacingThe letter spacing.
void te::at::Attributes::setLineJustification ( LineJustification  just)

It sets the multi line justification.

Parameters
justThe multi line justification.
void te::at::Attributes::setLineSpacing ( const double &  spacing)

It sets the multi line spacing.

Parameters
spacingThe multi line spacing.
void te::at::Attributes::setPointSize ( const double &  ps)

It sets the font point size.

Parameters
psThe font point size.
void te::at::Attributes::setStyle ( FontStyle  style)

It sets the font style.

Parameters
styleThe font style.
void te::at::Attributes::setTextColor ( const std::string &  color)

It sets the text color.

Parameters
colorThe text color.
void te::at::Attributes::setTextOpacity ( double &  opacity)

It sets the text opacity.

Parameters
opacityThe text opacity.
void te::at::Attributes::setTextStrokecolor ( const std::string &  color)

It sets the text stroke color.

Parameters
colorThe text stroke color.
void te::at::Attributes::setTextStrokeOpacity ( const double &  opacity)

It sets the text stroke opacity.

Parameters
opacityThe text stroke opacity.
void te::at::Attributes::setTextStrokeWidth ( const double &  width)

It sets the text stroke width.

Parameters
widthThe text stroke width.
void te::at::Attributes::setVerticalAlignment ( VerticalAlignment  va)

It sets the vertical text alignment.

Parameters
haThe vertical text alignment.
void te::at::Attributes::setWeight ( FontWeight  weight)

It sets the font weight.

Parameters
weightThe font weight.
void te::at::Attributes::setWordSpacing ( const double &  spacing)

It sets the word spacing.

Parameters
spacingThe word spacing.

Member Data Documentation

TextDecoration te::at::Attributes::m_decoration
private

text decoration

Definition at line 290 of file Attributes.h.

std::string te::at::Attributes::m_family
private

font family

Definition at line 286 of file Attributes.h.

std::string te::at::Attributes::m_fillColor
private

text fill color

Definition at line 293 of file Attributes.h.

double te::at::Attributes::m_fillOpacity
private

text fill color opacity (0..1)

Definition at line 294 of file Attributes.h.

HorizontalAlignment te::at::Attributes::m_hAlign
private

horizontal text alignment

Definition at line 298 of file Attributes.h.

double te::at::Attributes::m_letterSpacing
private

letter spacing (0..1)

Definition at line 291 of file Attributes.h.

LineJustification te::at::Attributes::m_multiLineJustification
private

multi line justufucation

Definition at line 300 of file Attributes.h.

double te::at::Attributes::m_multiLineSpacing
private

multi line spacing

Definition at line 301 of file Attributes.h.

double te::at::Attributes::m_pointSize
private

font point size

Definition at line 287 of file Attributes.h.

std::string te::at::Attributes::m_strokeColor
private

text stroke color

Definition at line 295 of file Attributes.h.

double te::at::Attributes::m_strokeOpacity
private

text stroke color opacity (0..1)

Definition at line 297 of file Attributes.h.

double te::at::Attributes::m_strokeWidth
private

text stroke width (0..1)

Definition at line 296 of file Attributes.h.

FontStyle te::at::Attributes::m_style
private

font style

Definition at line 288 of file Attributes.h.

VerticalAlignment te::at::Attributes::m_vAlign
private

vertical text alignment

Definition at line 299 of file Attributes.h.

FontWeight te::at::Attributes::m_weight
private

font weight

Definition at line 289 of file Attributes.h.

double te::at::Attributes::m_wordSpacing
private

word spacing (0..1)

Definition at line 292 of file Attributes.h.


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