VizKit  3.3.4
Public Member Functions | Private Attributes
VizKit::VisualStyledString Class Reference

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

#include <VisualStyledString.h>

Inheritance diagram for VizKit::VisualStyledString:
VizKit::VisualString VizKit::VisualObject

List of all members.

Public Member Functions

 VisualStyledString ()
 The constructor.
 ~VisualStyledString ()
 The destructor.
 VisualStyledString (const VisualStyledString &other)
 Copy constructor.
VisualStyledStringoperator= (const VisualStyledString &other)
 Assignment operator.
virtual VisualStyledStringclone (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.
VisualStringStylegetStyle (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

The constructor.

The destructor.

Copy constructor.

Parameters:
otherAnother VisualStyledString.

Member Function Documentation

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:
aMaxPixelWidthThe requested maximum width of the texture. If 0 the argument is ignored.
aMaxPixelHeightThe 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.

Reimplemented from VizKit::VisualString.

Returns the style of the string.

Returns:
The style of the string.
void VisualStyledString::initWithVisualString ( const VisualString anUnstyledString)

Initializes a VisualStyledString with a VisualString.

Parameters:
anUnstyledStringAn unstyled VisualString.
VisualStyledString & VisualStyledString::operator= ( const VisualStyledString other)

Assignment operator.

void VisualStyledString::setStyle ( const VisualStringStyle aStringStyle)

Sets the style of the VisualStyledString.

Parameters:
aStringStyleA string style.

Member Data Documentation

The style information of the string.


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

Generated on Sun Aug 4 2013 12:59:11 for VizKit by doxygen 1.8.0