This class stores information about the font, which is merely a file path and cached metadata about the font. More...

#include <Font_SystemFont.hxx>

Inheritance diagram for Font_SystemFont:

Public Member Functions
	Font_SystemFont (const TCollection_AsciiString &theFontName)
	Creates a new font object.

const TCollection_AsciiString &	FontKey () const
	Returns font family name (lower-cased).

const TCollection_AsciiString &	FontName () const
	Returns font family name.

const TCollection_AsciiString &	FontPath (Font_FontAspect theAspect) const
	Returns font file path.

Standard_Integer	FontFaceId (Font_FontAspect theAspect) const
	Returns font file path.

void	SetFontPath (Font_FontAspect theAspect, const TCollection_AsciiString &thePath, const Standard_Integer theFaceId=0)
	Sets font file path for specific aspect.

bool	HasFontAspect (Font_FontAspect theAspect) const
	Returns TRUE if dedicated file for specified font aspect has been defined.

const TCollection_AsciiString &	FontPathAny (Font_FontAspect theAspect, bool &theToSynthesizeItalic, Standard_Integer &theFaceId) const
	Returns any defined font file path.

Standard_Boolean	IsEqual (const Handle< Font_SystemFont > &theOtherFont) const
	Return true if the FontName, FontAspect and FontSize are the same.

Standard_Boolean	IsSingleStrokeFont () const
	Return TRUE if this is single-stroke (one-line) font, FALSE by default. Such fonts define single-line glyphs instead of closed contours, so that they are rendered incorrectly by normal software.

void	SetSingleStrokeFont (Standard_Boolean theIsSingleLine)
	Set if this font should be rendered as single-stroke (one-line).

TCollection_AsciiString	ToString () const
	Format font description.

bool	operator== (const Font_SystemFont &theFont) const

Public Member Functions inherited from Standard_Transient
	Standard_Transient ()
	Empty constructor.

	Standard_Transient (const Standard_Transient &)
	Copy constructor – does nothing.

Standard_Transient &	operator= (const Standard_Transient &)
	Assignment operator, needed to avoid copying reference counter.

virtual	~Standard_Transient ()
	Destructor must be virtual.

virtual const opencascade::handle< Standard_Type > &	DynamicType () const
	Returns a type descriptor about this object.

Standard_Boolean	IsInstance (const opencascade::handle< Standard_Type > &theType) const
	Returns a true value if this is an instance of Type.

Standard_Boolean	IsInstance (const Standard_CString theTypeName) const
	Returns a true value if this is an instance of TypeName.

Standard_Boolean	IsKind (const opencascade::handle< Standard_Type > &theType) const
	Returns true if this is an instance of Type or an instance of any class that inherits from Type. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Boolean	IsKind (const Standard_CString theTypeName) const
	Returns true if this is an instance of TypeName or an instance of any class that inherits from TypeName. Note that multiple inheritance is not supported by OCCT RTTI mechanism.

Standard_Transient *	This () const
	Returns non-const pointer to this object (like const_cast). For protection against creating handle to objects allocated in stack or call from constructor, it will raise exception Standard_ProgramError if reference counter is zero.

Standard_Integer	GetRefCount () const noexcept
	Get the reference counter of this object.

void	IncrementRefCounter () noexcept
	Increments the reference counter of this object.

Standard_Integer	DecrementRefCounter () noexcept
	Decrements the reference counter of this object; returns the decremented value.

virtual void	Delete () const
	Memory deallocator for transient classes.

Additional Inherited Members
Public Types inherited from Standard_Transient
typedef void	base_type
	Returns a type descriptor about this object.

Static Public Member Functions inherited from Standard_Transient
static constexpr const char *	get_type_name ()
	Returns a type descriptor about this object.

static const opencascade::handle< Standard_Type > &	get_type_descriptor ()
	Returns type descriptor of Standard_Transient class.

Detailed Description

This class stores information about the font, which is merely a file path and cached metadata about the font.

Constructor & Destructor Documentation

◆ Font_SystemFont()

Font_SystemFont::Font_SystemFont ( const TCollection_AsciiString & theFontName )

Creates a new font object.

Member Function Documentation

◆ FontFaceId()

Standard_Integer Font_SystemFont::FontFaceId ( Font_FontAspect theAspect ) const

inline

Returns font file path.

◆ FontKey()

const TCollection_AsciiString & Font_SystemFont::FontKey ( ) const

inline

Returns font family name (lower-cased).

◆ FontName()

const TCollection_AsciiString & Font_SystemFont::FontName ( ) const

inline

Returns font family name.

◆ FontPath()

const TCollection_AsciiString & Font_SystemFont::FontPath ( Font_FontAspect theAspect ) const

inline

Returns font file path.

◆ FontPathAny()

const TCollection_AsciiString & Font_SystemFont::FontPathAny	(	Font_FontAspect	theAspect,
		bool &	theToSynthesizeItalic,
		Standard_Integer &	theFaceId
	)		const

inline

Returns any defined font file path.

◆ HasFontAspect()

bool Font_SystemFont::HasFontAspect ( Font_FontAspect theAspect ) const

inline

Returns TRUE if dedicated file for specified font aspect has been defined.

◆ IsEqual()

Standard_Boolean Font_SystemFont::IsEqual ( const Handle< Font_SystemFont > & theOtherFont ) const

Return true if the FontName, FontAspect and FontSize are the same.

◆ IsSingleStrokeFont()

Standard_Boolean Font_SystemFont::IsSingleStrokeFont ( ) const

inline

Return TRUE if this is single-stroke (one-line) font, FALSE by default. Such fonts define single-line glyphs instead of closed contours, so that they are rendered incorrectly by normal software.

◆ operator==()

bool Font_SystemFont::operator== ( const Font_SystemFont & theFont ) const

inline

◆ SetFontPath()

void Font_SystemFont::SetFontPath	(	Font_FontAspect	theAspect,
		const TCollection_AsciiString &	thePath,
		const Standard_Integer	theFaceId = `0`
	)

Sets font file path for specific aspect.

◆ SetSingleStrokeFont()

void Font_SystemFont::SetSingleStrokeFont ( Standard_Boolean theIsSingleLine )

inline

Set if this font should be rendered as single-stroke (one-line).

◆ ToString()

TCollection_AsciiString Font_SystemFont::ToString ( ) const

Format font description.

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

Font_SystemFont.hxx

Public Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ Font_SystemFont()

Member Function Documentation

◆ FontFaceId()

◆ FontKey()

◆ FontName()

◆ FontPath()

◆ FontPathAny()

◆ HasFontAspect()

◆ IsEqual()

◆ IsSingleStrokeFont()

◆ operator==()

◆ SetFontPath()

◆ SetSingleStrokeFont()

◆ ToString()