FontFile is the base class for different font file resource implementations. More...

#include <kanzi/core.ui/font/font_file.hpp>

Inheritance diagram for kanzi::FontFile:

Classes
class	GlyphData
	GlyphData contains the metrics for an individual rendered glyph and its bitmap. More...

Public Types
typedef shared_ptr< GlyphData >	GlyphDataSharedPtr

Public Types inherited from kanzi::PropertyObject
typedef PropertyStorageContainer::const_iterator	PropertyStorageConstIterator

typedef vector< PropertyStoragePtr >	PropertyStorageContainer

typedef PropertyStorageContainer::iterator	PropertyStorageIterator

typedef intrusive_ptr< AbstractPropertyTypeDescriptor::PropertyStorage >	PropertyStoragePtr

typedef PropertyStorageContainer::reverse_iterator	PropertyStorageReverseIterator

Public Member Functions
virtual float	getAdvance (unsigned int glyphIndex) const
	Returns the advance metric of the given glyph.

virtual float	getAscender () const
	Returns the ascender of a font.

virtual RectangleFloat	getBoundingBox (unsigned int glyphIndex) const
	Returns the bounding box of the given glyph.

virtual float	getDescender () const
	Returns the descender of a font.

virtual FontEnginePlugin::FontEngine	getEngineType () const
	Returns the font engine type used by this font.

virtual GlyphDataSharedPtr	getGlyphData (unsigned int glyphIndex)
	Returns the bitmap data for the given glyph.

virtual unsigned int	getGlyphIndex (char32_t character) const
	Returns the glyph index in a font for the given unicode code point.

FontHintingPreference	getHintingPreference () const
	Gets the value of FontStyleConcept::HintingPreferenceProperty.

virtual float	getKerning (unsigned int previousGlyphIndex, unsigned int glyphIndex) const
	Returns the kerning between the given pair of glyphs.

virtual float	getLineHeight () const
	Returns the line height of a font.

virtual float	getMaximumGlyphHeight () const
	Returns the maximum height of glyphs in a font.

virtual float	getSize () const
	Returns the size of a font in pixels.

void	setHintingPreference (FontHintingPreference hintingPreference)
	Sets the value of FontStyleConcept::HintingPreferenceProperty.

virtual void	setSize (float size)
	Sets the size of a font in pixels.

	~FontFile () override
	Destructor.

Public Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsage () const
	Function for getting the memory usage of a resource.

const string &	getName () const
	Gets the resource name.

const string &	getUrl () const
	Gets the resource URL.

bool	isKeepAlive () const
	Tells if the resource has keep alive flag set.

void	reload ()

void	reloadFromFile (string_view filePath)

void	reloadFromKzb (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

void	setKeepAlive (bool keepAlive)
	Sets the keep alive flag.

void	setUrl (string_view url)
	Sets the resource URL.

	~Resource () override
	Destructor.

Public Member Functions inherited from kanzi::Object
AppliedStyleEntrySharedPtr	applyObjectStyle (kanzi::StyleSharedPtr style)
	Applies a style to an object.

void	applyObjectStyles ()
	Apply all styles for an object node.

Domain *	getDomain () const
	Returns the domain the object belongs to.

const Metaclass *	getDynamicMetaclass () const override
	Returns the metaclass of the dynamic type of the object.

MainLoopScheduler *	getMainLoopScheduler () const
	Returns the MainLoopScheduler instance of the associated Domain.

detail::MessageDispatcher *	getMessageDispatcher () const
	Returns the message dispatcher of the object.

ResourceManager *	getResourceManager () const
	Returns the resource manager of the object.

ScriptingContextSharedPtr	getScriptingContext () const
	Gets the scripting context of the object.

	Object (Domain *domain)

void	setScriptingContext (ScriptingContextSharedPtr context)
	Sets the scripting context of the object.

void	unapplyObjectStyle (AppliedStyleEntrySharedPtr appliedStyleEntry)

void	unapplyObjectStyles ()
	Unapplies and removes all applied styles.

	~Object () override

Public Member Functions inherited from kanzi::MetaObject
bool	isTypeOf (const Metaclass *objectType) const
	Determines if the type of this object is the given type or derived from it.

virtual	~MetaObject ()

Public Member Functions inherited from kanzi::PropertyObject
template<typename DataType >
void	addPropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	addPropertyModifierWithoutNotifyingHandlers (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)
	Adds a property modifier without notifying handlers.

template<typename DataType >
void	addPropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)

template<typename DataType >
void	addPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)

PropertyStorageContainer::iterator	beginPropertyStorage ()
	Returns the begin iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	beginPropertyStorage () const
	Returns the begin iterator to the internal property storage container.

void	clearPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

void	copyLocalValue (const PropertyObject &other, AbstractPropertyType propertyType)
	Copies local value of single property from another object.

void	copyLocalValues (const PropertyObject &other)
	Copies all local values from another object.

PropertyStorageContainer::iterator	endPropertyStorage ()
	Returns the end iterator to the internal property storage container.

PropertyStorageContainer::const_iterator	endPropertyStorage () const
	Returns the end iterator to the internal property storage container.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getAbstractPropertyBase (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalAbstractProperty (AbstractPropertyType abstractPropertyType) const

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalProperty (const PropertyType< DataType > &propertyType) const
	Evaluates the property value in the same way as the overload above but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
optional< typename PropertyType< DataType >::Traits::ReturnType >	getOptionalPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers, but does not default to the value in property metadata if there are no inputs to the property value.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getProperty (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property type.

template<typename DataType >
PropertyType< DataType >::Traits::ReturnType	getPropertyBase (const PropertyType< DataType > &propertyType) const
	Returns the current value of a property disregarding modifiers.

template<typename DataType >
size_t	getPropertyNotificationHandlerCount (const PropertyType< DataType > &propertyType) const
	Gets number of current notification handlers for given property type.

bool	hasBaseValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value, disregarding modifiers.

bool	hasLocalValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a local value set for the property.

bool	hasNonClassValue (AbstractPropertyType propertyType) const
	Evaluates whether there is a value of any precedence higher than class default value set for the property.

bool	hasValue (AbstractPropertyType propertyType) const
	Evaluates whether there are any inputs into the property value.

bool	isPropertyFlagSet (AbstractPropertyType propertyType, uint32_t flag) const

virtual void	onPropertyChanged (AbstractPropertyType propertyType, PropertyNotificationReason reason)
	Virtual function to handle property change notifications.

	PropertyObject ()

void	removeKzbProperties ()
	Remove all KZB properties.

void	removeKzbProperties (flat_set< AbstractPropertyType > *keepProperties)
	Remove all KZB properties that are not included in a given set.

template<typename DataType >
void	removeLocalPropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

void	removeLocalValue (AbstractPropertyType propertyType)
	Removes the local value associated with the property.

template<typename DataType >
void	removePropertyModifier (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner)

template<typename DataType >
void	removePropertyNotificationHandler (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::NotificationCallback callback, void *owner)

template<typename DataType >
void	removePropertyValueSource (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::TypedValueSource valueSource, void ownerPointer)

template<typename DataType >
void	setAbstractProperty (AbstractPropertyType abstractPropertyType, typename PropertyType< DataType >::Traits::ParameterType value)

template<typename DataType >
void	setProperty (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Traits::ParameterType value)
	Sets the local value of a property type.

void	setPropertyFlag (AbstractPropertyType propertyType, uint32_t flag)

KZ_DEPRECATED void	validatePropertyModifiers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

void	validatePropertyModifiersAndNotifyHandlers (AbstractPropertyType propertyType)
	Validates property modifiers and notifies handlers.

virtual	~PropertyObject ()

Static Public Member Functions
static FontFileSharedPtr	create (Domain *domain, string_view name)
	Construct fonts using the corresponding font loader implementation, not directly with the create() function.

Static Public Member Functions inherited from kanzi::Object
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Static Public Member Functions inherited from kanzi::MetaObject
static const Metaclass *	getStaticMetaclass ()
	Returns the metaclass of Object class.

static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()
	Default implementation that returns empty editor info.

Protected Member Functions
	FontFile (Domain *domain, string_view name)
	Construct fonts using the corresponding font loader implementation, not directly with the constructor.

void	setAscender (float ascender)
	Sets the ascender for a font.

void	setDescender (float descender)
	Sets the descender for a font.

void	setLineHeight (float lineHeight)
	Sets the line height for a font.

Protected Member Functions inherited from kanzi::Resource
virtual unsigned int	getCPUMemoryUsageOverride () const

virtual void	reloadFromFileOverride (string_view filePath)

virtual void	reloadFromKzbOverride (KzbFile &kzbFile, ReadOnlyMemoryFile &file, KzbMemoryParser &parser)

virtual void	reloadOverride ()

	Resource (Domain *domain, string_view name)
	Constructor.

Protected Member Functions inherited from kanzi::Object
void	initialize ()

void	onCopy (const Object &other)

Protected Member Functions inherited from kanzi::MetaObject
void	initialize ()

	MetaObject ()

Protected Member Functions inherited from kanzi::PropertyObject
AbstractPropertyTypeDescriptor::ValueSourceEntry *	acquireLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Acquires a local value source entry that is free for the assignment of a value.

AbstractPropertyTypeDescriptor::ModifierStorage *	acquireModifierStorage (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

AbstractPropertyTypeDescriptor::NotificationStorage *	acquireNotificationStorage (AbstractPropertyTypeDescriptor &descriptor)

PropertyStoragePtr	acquirePropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

template<typename DataType >
void	addPropertyModifierBase (const PropertyType< DataType > &propertyType, typename PropertyType< DataType >::Descriptor::ModifierCallback callback, void *owner, bool notify)
	Adds a property modifier entry to the property modifier stack and validates them.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, AbstractPropertyTypeDescriptor::ValueSourceOwner owner)
	Internally adds a property value source.

void	addPropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, PropertyValuePrecedence precedence, void ownerPointer)
	Internally adds a property value source.

AbstractPropertyTypeDescriptor::ValueSourceEntry *	constructLocalValueSourceEntry (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::PropertyStorage &propertyStorage)

PropertyStoragePtr	constructPropertyStorage (AbstractPropertyTypeDescriptor &descriptor)

void	copyLocalValue (const AbstractPropertyTypeDescriptor::PropertyStorage &otherPropertyStorage)
	Copy local value from property storage.

AbstractPropertyTypeDescriptor::ModifierStorage *	findModifierStorage (AbstractPropertyTypeDescriptor &descriptor)

AbstractPropertyTypeDescriptor::NotificationStorage *	findNotificationStorage (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::PropertyStorage *	findPropertyStorage (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the property storage for given property type descriptor.

PropertyStoragePtr	findPropertyStoragePtr (AbstractPropertyTypeDescriptor &descriptor) const
	Gets property storage intrusive pointer which you can use to hold a reference until the end of the operation.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByNameAndDataType (string_view name, PropertyDataType dataType) const
	Finds a property type descriptor by name and data type.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByQualifiedNameAndDataType (string_view qualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with qualified names.

AbstractPropertyTypeDescriptor *	findPropertyTypeDescriptorByUnqualifiedNameAndDataType (string_view unqualifiedName, PropertyDataType dataType) const
	Like findPropertyTypeDescriptorByNameAndDataType, but only searches by matching with unqualified names.

AbstractPropertyTypeDescriptor::ValueSource *	getClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getFinalValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getNonClassValueSource (AbstractPropertyTypeDescriptor &descriptor) const

AbstractPropertyTypeDescriptor::ValueSource *	getTopValueSource (AbstractPropertyTypeDescriptor &descriptor) const
	Gets the top-level value source for a given property descriptor.

virtual void	notifyPropertyHandlers (PropertyStoragePtr &storagePtr, PropertyNotificationReason reason)
	Notifies all property handlers on a property storage.

void	onCopy (const PropertyObject &other)

void	removeLocalValue (AbstractPropertyTypeDescriptor &descriptor, PropertyStoragePtr &propertyStorage)
	Removes a local value from the given property storage.

void	removePropertyValueSource (AbstractPropertyTypeDescriptor &descriptor, AbstractPropertyTypeDescriptor::ValueSource valueSource, void owner)
	Removes a property value source.

void	validatePropertyModifiers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers without notifying handlers.

void	validatePropertyModifiersAndNotifyHandlers (PropertyStoragePtr &propertyStorage)
	Validates property modifiers and notifies handlers.

Friends
class	FontLoader

Additional Inherited Members
Protected Types inherited from kanzi::Object
typedef vector< AppliedStyleEntrySharedPtr >	AppliedStyleContainer
	Applied style container.

Protected Attributes inherited from kanzi::Object
AppliedStyleContainer	m_appliedStyles
	Listing of applied styles applied to this object.

Detailed Description

FontFile is the base class for different font file resource implementations.

The base class itself provides a mock implementation of a font file resource.

Member Typedef Documentation

◆ GlyphDataSharedPtr

typedef shared_ptr<GlyphData> kanzi::FontFile::GlyphDataSharedPtr

Constructor & Destructor Documentation

◆ ~FontFile()

kanzi::FontFile::~FontFile ( )

override

Destructor.

◆ FontFile()

kanzi::FontFile::FontFile	(	Domain *	domain,
		string_view	name )

explicitprotected

Construct fonts using the corresponding font loader implementation, not directly with the constructor.

See also: FontManager::getFontLoader()

Parameters

domain	Pointer to domain object.
name	Name of the font.

Member Function Documentation

◆ create()

static FontFileSharedPtr kanzi::FontFile::create	(	Domain *	domain,
		string_view	name )

static

Construct fonts using the corresponding font loader implementation, not directly with the create() function.

See also: FontManager::getFontLoader()

Parameters

domain	Pointer to the domain object.
name	Name of the font.

◆ getEngineType()

virtual FontEnginePlugin::FontEngine kanzi::FontFile::getEngineType ( ) const

virtual

Returns the font engine type used by this font.

Returns: FontEngine type.

Reimplemented in kanzi::FreeTypeFontFile, and kanzi::ItypeFontFile.

◆ setSize()

virtual void kanzi::FontFile::setSize ( float size )

virtual

Sets the size of a font in pixels.

Parameters

size	Size in pixels.

Reimplemented in kanzi::BitmapFontFile, kanzi::FreeTypeFontFile, and kanzi::ItypeFontFile.

◆ getSize()

virtual float kanzi::FontFile::getSize ( ) const

virtual

Returns the size of a font in pixels.

Returns: Size of the font in pixels.

Reimplemented in kanzi::BitmapFontFile.

◆ getLineHeight()

virtual float kanzi::FontFile::getLineHeight ( ) const

virtual

Returns the line height of a font.

Returns: Line height of the font.

Reimplemented in kanzi::BitmapFontFile.

◆ getMaximumGlyphHeight()

virtual float kanzi::FontFile::getMaximumGlyphHeight ( ) const

virtual

Returns the maximum height of glyphs in a font.

Returns: The maximum height of glyphs in a font.

Since: Kanzi 3.9.7

Reimplemented in kanzi::FreeTypeFontFile.

◆ getAscender()

virtual float kanzi::FontFile::getAscender ( ) const

virtual

Returns the ascender of a font.

Returns: Ascender of the font.

Reimplemented in kanzi::BitmapFontFile.

◆ getDescender()

virtual float kanzi::FontFile::getDescender ( ) const

virtual

Returns the descender of a font.

Returns: Descender of the font.

Reimplemented in kanzi::BitmapFontFile.

◆ getGlyphIndex()

virtual unsigned int kanzi::FontFile::getGlyphIndex ( char32_t character ) const

virtual

Returns the glyph index in a font for the given unicode code point.

Parameters

character The unicode code point to use.

Returns: Glyph index for the given code point.

Reimplemented in kanzi::BitmapFontFile, kanzi::FreeTypeFontFile, and kanzi::ItypeFontFile.

◆ getAdvance()

virtual float kanzi::FontFile::getAdvance ( unsigned int glyphIndex ) const

virtual

Returns the advance metric of the given glyph.

Parameters

glyphIndex Index of the font glyph data acquired from getGlyphIndex().

Returns: Advance for the given glyph.

Reimplemented in kanzi::BitmapFontFile, kanzi::FreeTypeFontFile, and kanzi::ItypeFontFile.

◆ getBoundingBox()

virtual RectangleFloat kanzi::FontFile::getBoundingBox ( unsigned int glyphIndex ) const

virtual

Returns the bounding box of the given glyph.

Parameters

glyphIndex Index of the font glyph data acquired from getGlyphIndex().

Returns: Bounding box of the given glyph.

Reimplemented in kanzi::BitmapFontFile, kanzi::FreeTypeFontFile, and kanzi::ItypeFontFile.

◆ getKerning()

virtual float kanzi::FontFile::getKerning	(	unsigned int	previousGlyphIndex,
		unsigned int	glyphIndex ) const

virtual

Returns the kerning between the given pair of glyphs.

Parameters

previousGlyphIndex	Index of the font glyph data of the preceding glyph.
glyphIndex	Index of the font glyph data acquired from getGlyphIndex().

Returns: Kerning between the given glyph pair.

Reimplemented in kanzi::BitmapFontFile, kanzi::FreeTypeFontFile, and kanzi::ItypeFontFile.

◆ getHintingPreference()

FontHintingPreference kanzi::FontFile::getHintingPreference ( ) const

Gets the value of FontStyleConcept::HintingPreferenceProperty.

See also: setHintingPreference()

Since: Kanzi 3.9.0

◆ setHintingPreference()

void kanzi::FontFile::setHintingPreference ( FontHintingPreference hintingPreference )

Sets the value of FontStyleConcept::HintingPreferenceProperty.

Parameters

hintingPreference The hinting preference of the font.

See also: getHintingPreference()

Since: Kanzi 3.9.0

◆ getGlyphData()

virtual GlyphDataSharedPtr kanzi::FontFile::getGlyphData ( unsigned int glyphIndex )

virtual

Returns the bitmap data for the given glyph.

Parameters

glyphIndex Index of the font glyph data acquired from getGlyphIndex().

Returns: Bitmap data for the given glyph.

Reimplemented in kanzi::BitmapFontFile, kanzi::FreeTypeFontFile, and kanzi::ItypeFontFile.

◆ setLineHeight()

void kanzi::FontFile::setLineHeight ( float lineHeight )

protected

Sets the line height for a font.

The line height is based on the size of the font.

Parameters

lineHeight Line height to set.

◆ setAscender()

void kanzi::FontFile::setAscender ( float ascender )

protected

Sets the ascender for a font.

The ascender is based on the size of the font.

Parameters

ascender Ascender to set.

◆ setDescender()

void kanzi::FontFile::setDescender ( float descender )

protected

Sets the descender for a font.

The descender is based on the size of the font.

Parameters

descender Descender to set.

Friends And Related Symbol Documentation

◆ FontLoader

friend class FontLoader

friend

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

kanzi/core.ui/font/font_file.hpp

Classes

Public Types

Public Member Functions

Static Public Member Functions

Protected Member Functions

Friends

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ GlyphDataSharedPtr

Constructor & Destructor Documentation

◆ ~FontFile()

◆ FontFile()

Member Function Documentation

◆ create()

◆ getEngineType()

◆ setSize()

◆ getSize()

◆ getLineHeight()

◆ getMaximumGlyphHeight()

◆ getAscender()

◆ getDescender()

◆ getGlyphIndex()

◆ getAdvance()

◆ getBoundingBox()

◆ getKerning()

◆ getHintingPreference()

◆ setHintingPreference()

◆ getGlyphData()

◆ setLineHeight()

◆ setAscender()

◆ setDescender()

Friends And Related Symbol Documentation

◆ FontLoader