Unicode string with styling or formatting information. More...

#include <VisualStyledString.h>

Inheritance diagram for VizKit::VisualStyledString:

Public Member Functions
	VisualStyledString ()
	The constructor.
	~VisualStyledString ()
	The destructor.
	VisualStyledString (const VisualStyledString &other)
	Copy constructor.
VisualStyledString &	operator= (const VisualStyledString &other)
	Assignment operator.
virtual VisualStyledString *	clone (void) const
	Copies the current VisualStyledString and returns a pointer to a new VisualStyledString.
void	initWithVisualString (const VisualString &anUnstyledString)
	Initializes a VisualStyledString with a VisualString.
void	setStyle (const VisualStringStyle &aStringStyle)
	Sets the style of the VisualStyledString.
VisualStringStyle &	getStyle (void)
	Returns the style of the string.
PixelRect	bitmapPixelRect (size_t aMaxPixelWidth, size_t aMaxPixelHeight)
	Returns the size (width and height in pixels) of an ARGB bitmap of a styled string.
Private Attributes
VisualStringStyle	stringStyle
	The style information of the string.

Detailed Description

Unicode string with styling or formatting information.

Constructor & Destructor Documentation

VisualStyledString::VisualStyledString ( )

The constructor.

VisualStyledString::~VisualStyledString ( )

The destructor.

VisualStyledString::VisualStyledString ( const VisualStyledString & other )

Copy constructor.

Parameters:

other Another VisualStyledString.

PixelRect VisualStyledString::bitmapPixelRect	(	size_t	aMaxPixelWidth,
		size_t	aMaxPixelHeight
	)

Returns the size (width and height in pixels) of an ARGB bitmap of a styled string.

Parameters:

aMaxPixelWidth	The requested maximum width of the texture. If 0 the argument is ignored.
aMaxPixelHeight	The requested maximum height of the texture. If 0 the argument is ignored.

VisualStyledString * VisualStyledString::clone ( void ) const [virtual]

Copies the current VisualStyledString and returns a pointer to a new VisualStyledString.

VisualStringStyle & VisualStyledString::getStyle ( void )

Returns the style of the string.

void VisualStyledString::initWithVisualString ( const VisualString & anUnstyledString )

Parameters:

anUnstyledString An unstyled VisualString.

VisualStyledString & VisualStyledString::operator= ( const VisualStyledString & other )

Assignment operator.

void VisualStyledString::setStyle ( const VisualStringStyle & aStringStyle )

Sets the style of the VisualStyledString.

Parameters:

aStringStyle A string style.

The style information of the string.

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