PowerUI.CharacterProvider Class Reference

Detailed Description

This class provides graphical characters, such as for Emoji. Each one of these defines a range of unicode characters that it provides for. Any character found within it's defined range will be directed to the provider, but only if it wasn't found in the font.

Public Member Functions

 CharacterProvider (string path, int minimum, int maximum)
 Creates a character provider for characters in the specified range. More...
 
ImagePackage Load (Glyph glyph, int charcode)
 Called when the given character was not found in the font. More...
 
void ImageReady (ImagePackage package)
 Called when an image has been received. More...
 
virtual string GetPath (int charcode)
 Gets the path to the image for the given character code. Override this if you want to define a custom location for your characters. More...
 

Public Attributes

int MinimumID
 The minimum charcode of the range of characters this provides for. More...
 
int MaximumID
 The maximum charcode of the range of characters this provides for. More...
 
string Path
 The path to attempt finding a character in. The characters must be .png files. More...
 

Constructor & Destructor Documentation

PowerUI.CharacterProvider.CharacterProvider ( string  path,
int  minimum,
int  maximum 
)
inline

Creates a character provider for characters in the specified range.

Parameters
pathThe URL where the characters are coming from.
minimumThe minimum charcode of the range of characters this provides for.
maximumThe maximum charcode of the range of characters this provides for.

Member Function Documentation

virtual string PowerUI.CharacterProvider.GetPath ( int  charcode)
inlinevirtual

Gets the path to the image for the given character code. Override this if you want to define a custom location for your characters.

Parameters
charcodeThe charcode of the character to look for.
Returns
The path to the charcode.
void PowerUI.CharacterProvider.ImageReady ( ImagePackage  package)
inline

Called when an image has been received.

Parameters
packageThe package holding the image.
ImagePackage PowerUI.CharacterProvider.Load ( Glyph  glyph,
int  charcode 
)
inline

Called when the given character was not found in the font.

Parameters
glyphThe character to try and find an alternate image for.</param.

Member Data Documentation

int PowerUI.CharacterProvider.MaximumID

The maximum charcode of the range of characters this provides for.

int PowerUI.CharacterProvider.MinimumID

The minimum charcode of the range of characters this provides for.

string PowerUI.CharacterProvider.Path

The path to attempt finding a character in. The characters must be .png files.