FontPalette Class Reference

Public Member Functions
bool	operator== (FontPalette &rhs)
bool	operator!= (FontPalette &rhs)
bool	isNULL (void)
std::vector< string >	GetAvailableFonts (void)
std::vector< Font >	GetReferencedFonts (void)
std::vector< Font >	GetAdditionalFonts (void)
bool	RemoveAdditionalFontKey (String fontKey)
bool	RemoveAdditionalFont (Font &font)
bool	AddAdditionalFont (Font &font)
bool	AddFontGlyphRange (Font &font, unsigned int start, unsigned int end)
bool	RemoveFontGlyphRange (Font &font, unsigned int start, unsigned int end)
bool	RemoveUnicodeFontRanges (Font &font)

Public Attributes
newobject	GetAvailableFonts
newobject	GetReferencedFonts
newobject	GetAdditionalFonts

Detailed Description

Python extension for the FontPalette editor class.

Member Function Documentation

bool FontPalette::AddAdditionalFont

(

Font &

font

)

Adds a font to the Additional Fonts list of the document.

Parameters

font	the font to be added

Returns

boolean representing whether a font has been added or not

bool FontPalette::AddFontGlyphRange	(	Font &	font,
		unsigned int	start,
		unsigned int	end
	)

Adds the specified range to the given unicode font.

Parameters

font	the font to be modified
start	the starting value for the range, min 256, max 65534
end	the ending value for the range, min 256, max 65534

Returns

boolean representing whether the glyph range could be added or not

std::vector<Font> FontPalette::GetAdditionalFonts

(

void

)

Gets the list of Additional Fonts fonts referenced by the document.

Returns

a vector of Fonts references by the document

std::vector<string> FontPalette::GetAvailableFonts

(

void

)

Gets the list of fonts available to the editor.

Returns

a vector of strings containing the available font family names

std::vector<Font> FontPalette::GetReferencedFonts

(

void

)

Gets the list of fonts referenced by the document.

Returns

a vector of Fonts references by the document

bool FontPalette::isNULL

(

void

)

determine if font palette does not exist.

Returns

True if this object represents a NULL font palette

Deprecated:

Refer to the Truth Value Checking page

bool FontPalette::operator!=

(

FontPalette &

rhs

)

inequality operator.

Parameters

rhs	instance to compare

bool FontPalette::operator==

(

FontPalette &

rhs

)

equality operator.

Parameters

rhs	instance to compare

bool FontPalette::RemoveAdditionalFont

(

Font &

font

)

Removes a font from the Additional Fonts list of the document.

Parameters

font	the font to be removed

Returns

boolean representing whether a font has been removed or not

bool FontPalette::RemoveAdditionalFontKey

(

String

fontKey

)

Removes a font from the Additional Fonts list of the document by full name.

Parameters

fontKey

the key of the font to be removed, such as "ArialRegular12"

Returns

boolean representing whether a font has been removed or not

bool FontPalette::RemoveFontGlyphRange	(	Font &	font,
		unsigned int	start,
		unsigned int	end
	)

Removes the specified range from the given unicode font.

Parameters

font	the font to be modified
start	the starting value for the range
end	the ending value for the range

Returns

boolean representing whether the glyph range could be removed or not

bool FontPalette::RemoveUnicodeFontRanges

(

Font &

font

)

Removes the font from the list of Unicode fonts, and its set ranges along with it.

Note that it will be re-added with the default range if the font is still in the "Additional Fonts" list.

Parameters

font	the font to be modified

Returns

boolean representing whether the ranges could be removed or not

Member Data Documentation

newobject FontPalette::GetAdditionalFonts

newobject FontPalette::GetAvailableFonts

newobject FontPalette::GetReferencedFonts

---

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

• FontPalette.i