fe::DecorMetrics Class Reference
[Ferry Core library]

Wrapper for attributes of a decorated part of text line. More...

List of all members.

Public Types

enum  Type { Unknown, Simple, Decorator }

Public Member Functions

 DecorMetrics (ISubstringDecorator &sd)
 DecorMetrics (const TextStyle &ts)
 DecorMetrics ()
ISubstringDecoratorgetSubstringDecorator () const
TextStyle getTextStyle () const
Type getType () const
bool operator!= (const DecorMetrics &v) const
bool operator== (const DecorMetrics &v) const


Detailed Description

Wrapper for attributes of a decorated part of text line.

See also:
fe::IDecorator

Member Enumeration Documentation

Wrapped data type.

Enumerator:
Unknown  No data wrapped.
Simple  fe::TextStyle instance wrapped.
Decorator  fe::ISubstringDecorator pointer wrapped.


Constructor & Destructor Documentation

fe::DecorMetrics::DecorMetrics (  )  [inline]

Constructs empty fe::DecorMetrics (no data to wrap).

fe::DecorMetrics::DecorMetrics ( const TextStyle ts  )  [inline, explicit]

Constructs fe::DecorMetrics with a wrapped fe::TextStyle instance.

Parameters:
ts data to wrap

fe::DecorMetrics::DecorMetrics ( ISubstringDecorator sd  )  [inline, explicit]

Constructs fe::DecorMetrics with a wrapped fe::ISubstringDecorator pointer.

Parameters:
sd data to wrap


Member Function Documentation

bool fe::DecorMetrics::operator== ( const DecorMetrics v  )  const [inline]

bool fe::DecorMetrics::operator!= ( const DecorMetrics v  )  const [inline]

Type fe::DecorMetrics::getType (  )  const [inline]

Returns type of a wrapped data.

TextStyle fe::DecorMetrics::getTextStyle (  )  const [inline]

Returns wrapped data. The returned data is valid only if getType() returns Simple.

ISubstringDecorator* fe::DecorMetrics::getSubstringDecorator (  )  const [inline]

Returns wrapped data. The returned data is valid only if getType() returns Decorator.


Member Data Documentation


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

Generated on Tue Nov 18 21:08:23 2008 for Ferry by doxygen 1.5.7.1
http://sourceforge.net