Open CASCADE Technology  7.4.0.beta
Public Member Functions | Static Public Member Functions
Font_SystemFont Class Reference

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:
Inheritance graph
[legend]

Public Member Functions

 Font_SystemFont (const TCollection_AsciiString &theFontName)
 Creates a new font object. More...
 
const TCollection_AsciiStringFontKey () const
 Returns font family name (lower-cased). More...
 
const TCollection_AsciiStringFontName () const
 Returns font family name. More...
 
const TCollection_AsciiStringFontPath (Font_FontAspect theAspect) const
 Returns font file path. More...
 
void SetFontPath (Font_FontAspect theAspect, const TCollection_AsciiString &thePath)
 Sets font file path for specific aspect. More...
 
bool HasFontAspect (Font_FontAspect theAspect) const
 Returns TRUE if dedicated file for specified font aspect has been defined. More...
 
const TCollection_AsciiStringFontPathAny (Font_FontAspect theAspect, bool &theToSynthesizeItalic) const
 Returns any defined font file path. More...
 
Standard_Boolean IsEqual (const Handle< Font_SystemFont > &theOtherFont) const
 Return true if the FontName, FontAspect and FontSize are the same. More...
 
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. More...
 
void SetSingleStrokeFont (Standard_Boolean theIsSingleLine)
 Set if this font should be rendered as single-stroke (one-line). More...
 
TCollection_AsciiString ToString () const
 Format font description. More...
 
- Public Member Functions inherited from Standard_Transient
 Standard_Transient ()
 Empty constructor. More...
 
 Standard_Transient (const Standard_Transient &)
 Copy constructor – does nothing. More...
 
Standard_Transientoperator= (const Standard_Transient &)
 Assignment operator, needed to avoid copying reference counter. More...
 
virtual ~Standard_Transient ()
 Destructor must be virtual. More...
 
virtual void Delete () const
 Memory deallocator for transient classes. More...
 
virtual const opencascade::handle< Standard_Type > & DynamicType () const
 Returns a type descriptor about this object. More...
 
Standard_Boolean IsInstance (const opencascade::handle< Standard_Type > &theType) const
 Returns a true value if this is an instance of Type. More...
 
Standard_Boolean IsInstance (const Standard_CString theTypeName) const
 Returns a true value if this is an instance of TypeName. More...
 
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. More...
 
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. More...
 
Standard_TransientThis () 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. More...
 
Standard_Integer GetRefCount () const
 Get the reference counter of this object. More...
 
void IncrementRefCounter () const
 Increments the reference counter of this object. More...
 
Standard_Integer DecrementRefCounter () const
 Decrements the reference counter of this object; returns the decremented value. More...
 

Static Public Member Functions

static Standard_Integer HashCode (const Handle< Font_SystemFont > &theSystemFont, const Standard_Integer theUpperBound)
 Computes a hash code for the system font, in the range [1, theUpperBound]. Based on Font Family, so that the whole family with different aspects can be found within the same bucket of some map. More...
 
static bool IsEqual (const Handle< Font_SystemFont > &theFont1, const Handle< Font_SystemFont > &theFont2)
 Matching two instances, for Map interface. More...
 
- Static Public Member Functions inherited from Standard_Transient
static const char * get_type_name ()
 Returns a type descriptor about this object. More...
 
static const opencascade::handle< Standard_Type > & get_type_descriptor ()
 Returns type descriptor of Standard_Transient class. More...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. More...
 

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

◆ 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 
) 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.

◆ HashCode()

static Standard_Integer Font_SystemFont::HashCode ( const Handle< Font_SystemFont > &  theSystemFont,
const Standard_Integer  theUpperBound 
)
inlinestatic

Computes a hash code for the system font, in the range [1, theUpperBound]. Based on Font Family, so that the whole family with different aspects can be found within the same bucket of some map.

Parameters
theSystemFontthe system font which hash code is to be computed
theUpperBoundthe upper bound of the range a computing hash code must be within
Returns
a computed hash code, in the range [1, theUpperBound]

◆ IsEqual() [1/2]

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

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

◆ IsEqual() [2/2]

static bool Font_SystemFont::IsEqual ( const Handle< Font_SystemFont > &  theFont1,
const Handle< Font_SystemFont > &  theFont2 
)
inlinestatic

Matching two instances, for Map interface.

◆ 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.

◆ SetFontPath()

void Font_SystemFont::SetFontPath ( Font_FontAspect  theAspect,
const TCollection_AsciiString thePath 
)

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: