Implementation class for FontStyleConcept. More...

#include <kanzi/ui/node/concept/font_style_concept.hpp>

Inheritance diagram for kanzi::FontStyleConceptImpl< TDerivedClass >:

Public Member Functions
float	getCharacterSpacing () const
	Gets the value of the FontStyleConcept::CharacterSpacingProperty property.

float	getFixedCharacterWidth () const
	Gets the value of the FontStyleConcept::FixedCharacterWidthProperty property.

float	getFontSize () const
	Gets the value of the FontStyleConcept::SizeProperty property.

FontStyle	getFontStyle () const
	Gets the value of the FontStyleConcept::StyleProperty property.

FontWeight	getFontWeight () const
	Gets the value of the FontStyleConcept::WeightProperty property.

bool	getFractionalCharacterWidth () const
	Gets the value of the FontStyleConcept::FractionalCharacterWidthProperty property.

FontHintingPreference	getHintingPreference () const
	Gets the value of HintingPreferenceProperty.

float	getLineSpacing () const
	Gets the value of the FontStyleConcept::LineSpacingProperty property.

FontRuntimeSharedPtr	getRuntimeFont ()
	Gets the runtime font.

bool	getSnapCharacterToPixel () const
	Gets the value of the FontStyleConcept::SnapCharacterToPixelProperty property.

void	releaseRuntimeFont ()
	Releases the runtime font that is held by FontStyleConceptImpl.

void	setCharacterSpacing (float value)
	Sets the value of the FontStyleConcept::CharacterSpacingProperty property.

void	setFixedCharacterWidth (float value)
	Sets the value of the FontStyleConcept::FixedCharacterWidthProperty property.

void	setFontSize (float value)
	Sets the value of the FontStyleConcept::SizeProperty property.

void	setFontStyle (FontStyle style)
	Sets the value of the FontStyleConcept::StyleProperty property.

void	setFontWeight (FontWeight weight)
	Sets the value of the FontStyleConcept::WeightProperty property.

void	setFractionalCharacterWidth (bool enable)
	Sets the value of the FontStyleConcept::FractionalCharacterWidthProperty property.

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

void	setLineSpacing (float value)
	Sets the value of the FontStyleConcept::LineSpacingProperty property.

void	setSnapCharacterToPixel (bool enable)
	Sets the value of the FontStyleConcept::SnapCharacterToPixelProperty property.

bool	updateRuntimeFont ()
	Updates the runtime font.

Protected Member Functions
	FontStyleConceptImpl ()=default
	Constructor.

Additional Inherited Members
Static Public Member Functions inherited from kanzi::FontStyleConcept
static PropertyTypeEditorInfoSharedPtr	makeEditorInfo ()

Static Public Attributes inherited from kanzi::FontStyleConcept
static PropertyType< float >	SizeProperty
	Sets the size for the font in pixels.

static PropertyType< FontStyle >	StyleProperty
	Sets the style for the font.

static PropertyType< FontWeight >	WeightProperty
	Sets the weight for the font.

static PropertyType< float >	CharacterSpacingProperty
	Sets the character spacing in pixels.

static PropertyType< float >	FixedCharacterWidthProperty
	Overrides the font advance widths and makes each character take a fixed amount of space specified in pixels.

static PropertyType< float >	LineSpacingProperty
	Sets the line spacing in multiples of the normal line height of the selected font.

static PropertyType< bool >	FractionalCharacterWidthProperty
	Sets whether Kanzi uses fractional or rounded character widths to lay out text.

static PropertyType< bool >	SnapCharacterToPixelProperty
	Sets whether Kanzi positions characters in 2D rendering to the nearest pixel:

static PropertyType< FontHintingPreference >	HintingPreferenceProperty
	Sets the hinting preference of the selected font.

Detailed Description

template<typename TDerivedClass>
class kanzi::FontStyleConceptImpl< TDerivedClass >

Implementation class for FontStyleConcept.

Since: Kanzi 3.8.0

Constructor & Destructor Documentation

◆ FontStyleConceptImpl()

template<typename TDerivedClass >

kanzi::FontStyleConceptImpl< TDerivedClass >::FontStyleConceptImpl ( )

explicitprotecteddefault

Constructor.

Member Function Documentation

◆ updateRuntimeFont()

template<typename TDerivedClass >

bool kanzi::FontStyleConceptImpl< TDerivedClass >::updateRuntimeFont ( )

Updates the runtime font.

If FontStyleConceptImpl does not yet have a runtime font, fetches a new runtime font. In case runtime font does not match with the node properties, which determine the font characteristics, fetches a new runtime font.

Returns: If a new runtime font is fetched, true, otherwise false.

◆ getRuntimeFont()

template<typename TDerivedClass >

FontRuntimeSharedPtr kanzi::FontStyleConceptImpl< TDerivedClass >::getRuntimeFont ( )

Gets the runtime font.

If FontStyleConceptImpl does not yet have a runtime font, fetches a new runtime font.

Returns: Pointer to the runtime font.

◆ releaseRuntimeFont()

template<typename TDerivedClass >

void kanzi::FontStyleConceptImpl< TDerivedClass >::releaseRuntimeFont ( )

Releases the runtime font that is held by FontStyleConceptImpl.

◆ getFontSize()

template<typename TDerivedClass >

float kanzi::FontStyleConceptImpl< TDerivedClass >::getFontSize ( ) const

Gets the value of the FontStyleConcept::SizeProperty property.

Returns: The size of the font in pixels.

See also: setFontSize()

◆ setFontSize()

template<typename TDerivedClass >

void kanzi::FontStyleConceptImpl< TDerivedClass >::setFontSize ( float value )

Sets the value of the FontStyleConcept::SizeProperty property.

Parameters

value The size of the font in pixels.

See also: getFontSize()

◆ getFontStyle()

template<typename TDerivedClass >

FontStyle kanzi::FontStyleConceptImpl< TDerivedClass >::getFontStyle ( ) const

Gets the value of the FontStyleConcept::StyleProperty property.

Returns: The requested style for the font file that Kanzi fetches from the selected font family.

See also: setFontStyle()

◆ setFontStyle()

template<typename TDerivedClass >

void kanzi::FontStyleConceptImpl< TDerivedClass >::setFontStyle ( FontStyle style )

Sets the value of the FontStyleConcept::StyleProperty property.

Parameters

style The requested style for the font file that Kanzi fetches from the selected font family.

See also: getFontStyle()

◆ getFontWeight()

template<typename TDerivedClass >

FontWeight kanzi::FontStyleConceptImpl< TDerivedClass >::getFontWeight ( ) const

Gets the value of the FontStyleConcept::WeightProperty property.

Returns: The requested weight for the font file that Kanzi fetches from the selected font family.

See also: setFontWeight()

◆ setFontWeight()

template<typename TDerivedClass >

void kanzi::FontStyleConceptImpl< TDerivedClass >::setFontWeight ( FontWeight weight )

Sets the value of the FontStyleConcept::WeightProperty property.

Parameters

weight The requested weight for the font file that Kanzi fetches from the selected font family.

See also: getFontWeight()

◆ getLineSpacing()

template<typename TDerivedClass >

float kanzi::FontStyleConceptImpl< TDerivedClass >::getLineSpacing ( ) const

Gets the value of the FontStyleConcept::LineSpacingProperty property.

Returns: The line spacing in multiples of the normal line height of the selected font.

See also: setLineSpacing()

◆ setLineSpacing()

template<typename TDerivedClass >

void kanzi::FontStyleConceptImpl< TDerivedClass >::setLineSpacing ( float value )

Sets the value of the FontStyleConcept::LineSpacingProperty property.

Parameters

value The line spacing in multiples of the normal line height of the selected font.

See also: getLineSpacing()

◆ getCharacterSpacing()

template<typename TDerivedClass >

float kanzi::FontStyleConceptImpl< TDerivedClass >::getCharacterSpacing ( ) const

Gets the value of the FontStyleConcept::CharacterSpacingProperty property.

Returns: The character spacing in pixels.

See also: setCharacterSpacing()

◆ setCharacterSpacing()

template<typename TDerivedClass >

void kanzi::FontStyleConceptImpl< TDerivedClass >::setCharacterSpacing ( float value )

Sets the value of the FontStyleConcept::CharacterSpacingProperty property.

Parameters

value The character spacing in pixels.

See also: getCharacterSpacing()

◆ getFixedCharacterWidth()

template<typename TDerivedClass >

float kanzi::FontStyleConceptImpl< TDerivedClass >::getFixedCharacterWidth ( ) const

Gets the value of the FontStyleConcept::FixedCharacterWidthProperty property.

Returns: The fixed character width in pixels.

See also: setFixedCharacterWidth()

◆ setFixedCharacterWidth()

template<typename TDerivedClass >

void kanzi::FontStyleConceptImpl< TDerivedClass >::setFixedCharacterWidth ( float value )

Sets the value of the FontStyleConcept::FixedCharacterWidthProperty property.

Parameters

value The fixed character width in pixels.

See also: getFixedCharacterWidth()

◆ getFractionalCharacterWidth()

template<typename TDerivedClass >

bool kanzi::FontStyleConceptImpl< TDerivedClass >::getFractionalCharacterWidth ( ) const

Gets the value of the FontStyleConcept::FractionalCharacterWidthProperty property.

Returns: If fractional character width is enabled, true, otherwise false.

See also: setFractionalCharacterWidth()

Since: Kanzi 3.9.0

◆ setFractionalCharacterWidth()

template<typename TDerivedClass >

void kanzi::FontStyleConceptImpl< TDerivedClass >::setFractionalCharacterWidth ( bool enable )

Sets the value of the FontStyleConcept::FractionalCharacterWidthProperty property.

Parameters

enable To enable fractional character width, set to true.

See also: getFractionalCharacterWidth()

Since: Kanzi 3.9.0

◆ getSnapCharacterToPixel()

template<typename TDerivedClass >

bool kanzi::FontStyleConceptImpl< TDerivedClass >::getSnapCharacterToPixel ( ) const

Gets the value of the FontStyleConcept::SnapCharacterToPixelProperty property.

Returns: If snap character to pixel is enabled, true, otherwise false.

See also: setSnapCharacterToPixel()

Since: Kanzi 3.9.0

◆ setSnapCharacterToPixel()

template<typename TDerivedClass >

void kanzi::FontStyleConceptImpl< TDerivedClass >::setSnapCharacterToPixel ( bool enable )

Sets the value of the FontStyleConcept::SnapCharacterToPixelProperty property.

Parameters

enable To enable snap character to pixel, set to true.

See also: getSnapCharacterToPixel()

Since: Kanzi 3.9.0

◆ getHintingPreference()

template<typename TDerivedClass >

FontHintingPreference kanzi::FontStyleConceptImpl< TDerivedClass >::getHintingPreference ( ) const

Gets the value of HintingPreferenceProperty.

See also: setHintingPreference()

Since: Kanzi 3.9.0

◆ setHintingPreference()

template<typename TDerivedClass >

void kanzi::FontStyleConceptImpl< TDerivedClass >::setHintingPreference ( FontHintingPreference hintingPreference )

Sets the value of HintingPreferenceProperty.

Parameters

hintingPreference The hinting preference of the font.

See also: getHintingPreference()

Since: Kanzi 3.9.0

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

kanzi/ui/node/concept/font_style_concept.hpp
kanzi/ui/node/concept/font_style_concept_impl.hpp

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ FontStyleConceptImpl()

Member Function Documentation

◆ updateRuntimeFont()

◆ getRuntimeFont()

◆ releaseRuntimeFont()

◆ getFontSize()

◆ setFontSize()

◆ getFontStyle()

◆ setFontStyle()

◆ getFontWeight()

◆ setFontWeight()

◆ getLineSpacing()

◆ setLineSpacing()

◆ getCharacterSpacing()

◆ setCharacterSpacing()

◆ getFixedCharacterWidth()

◆ setFixedCharacterWidth()

◆ getFractionalCharacterWidth()

◆ setFractionalCharacterWidth()

◆ getSnapCharacterToPixel()

◆ setSnapCharacterToPixel()

◆ getHintingPreference()

◆ setHintingPreference()