Open CASCADE Technology  7.3.0
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 ()
 Creates an empty font object. More...
 
 Font_SystemFont (const Handle< TCollection_HAsciiString > &theFontName, const Font_FontAspect theFontAspect, const Handle< TCollection_HAsciiString > &theFilePath)
 Creates a new font object. More...
 
 Font_SystemFont (const Handle< TCollection_HAsciiString > &theXLFD, const Handle< TCollection_HAsciiString > &theFilePath)
 Creates a font object and initialize class fields with values taken from XLFD (X Logical Font Description) More...
 
const Handle< TCollection_HAsciiString > & FontName () const
 Returns font family name. More...
 
const Handle< TCollection_HAsciiString > & FontPath () const
 Returns font file path. More...
 
Font_FontAspect FontAspect () const
 Returns font aspect. More...
 
Standard_Integer FontHeight () const
 Returns font height. If returned value is equal -1 it means that font is resizable. More...
 
Standard_Boolean IsValid () const
 
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...
 
- 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...
 

Additional Inherited Members

- Public Types inherited from Standard_Transient
typedef void base_type
 Returns a type descriptor about this object. 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...
 

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() [1/3]

Font_SystemFont::Font_SystemFont ( )

Creates an empty font object.

◆ Font_SystemFont() [2/3]

Font_SystemFont::Font_SystemFont ( const Handle< TCollection_HAsciiString > &  theFontName,
const Font_FontAspect  theFontAspect,
const Handle< TCollection_HAsciiString > &  theFilePath 
)

Creates a new font object.

◆ Font_SystemFont() [3/3]

Font_SystemFont::Font_SystemFont ( const Handle< TCollection_HAsciiString > &  theXLFD,
const Handle< TCollection_HAsciiString > &  theFilePath 
)

Creates a font object and initialize class fields with values taken from XLFD (X Logical Font Description)

Member Function Documentation

◆ FontAspect()

Font_FontAspect Font_SystemFont::FontAspect ( ) const
inline

Returns font aspect.

◆ FontHeight()

Standard_Integer Font_SystemFont::FontHeight ( ) const
inline

Returns font height. If returned value is equal -1 it means that font is resizable.

◆ FontName()

const Handle< TCollection_HAsciiString >& Font_SystemFont::FontName ( ) const
inline

Returns font family name.

◆ FontPath()

const Handle< TCollection_HAsciiString >& Font_SystemFont::FontPath ( ) const
inline

Returns font file path.

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

◆ IsValid()

Standard_Boolean Font_SystemFont::IsValid ( ) const

◆ SetSingleStrokeFont()

void Font_SystemFont::SetSingleStrokeFont ( Standard_Boolean  theIsSingleLine)
inline

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


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