Open CASCADE Technology  7.4.0.beta
Data Structures | Public Member Functions | Static Public Member Functions
Font_FontMgr Class Reference

Collects and provides information about available fonts in system. More...

#include <Font_FontMgr.hxx>

Inheritance diagram for Font_FontMgr:
Inheritance graph
[legend]

Public Member Functions

void AvailableFonts (Font_NListOfSystemFont &theList) const
 Return the list of available fonts. More...
 
Font_NListOfSystemFont GetAvailableFonts () const
 Return the list of available fonts. More...
 
void GetAvailableFontsNames (TColStd_SequenceOfHAsciiString &theFontsNames) const
 Returns sequence of available fonts names. More...
 
Handle< Font_SystemFontGetFont (const Handle< TCollection_HAsciiString > &theFontName, const Font_FontAspect theFontAspect, const Standard_Integer theFontSize) const
 Returns font that match given parameters. If theFontName is empty string returned font can have any FontName. If theFontAspect is Font_FA_Undefined returned font can have any FontAspect. If theFontSize is "-1" returned font can have any FontSize. More...
 
Handle< Font_SystemFontGetFont (const TCollection_AsciiString &theFontName) const
 Returns font that match given name or NULL if such font family is NOT registered. Note that unlike FindFont(), this method ignores font aliases and does not look for fall-back. More...
 
Handle< Font_SystemFontFindFont (const TCollection_AsciiString &theFontName, Font_StrictLevel theStrictLevel, Font_FontAspect &theFontAspect) const
 Tries to find font by given parameters. If the specified font is not found tries to use font names mapping. If the requested family name not found -> search for any font family with given aspect and height. If the font is still not found, returns any font available in the system. Returns NULL in case when the fonts are not found in the system. More...
 
Handle< Font_SystemFontFindFont (const TCollection_AsciiString &theFontName, Font_FontAspect &theFontAspect) const
 Tries to find font by given parameters. More...
 
Handle< Font_SystemFontFindFallbackFont (Font_UnicodeSubset theSubset, Font_FontAspect theFontAspect) const
 Tries to find fallback font for specified Unicode subset. Returns NULL in case when fallback font is not found in the system. More...
 
Handle< Font_SystemFontCheckFont (const Standard_CString theFontPath) const
 Read font file and retrieve information from it. More...
 
Standard_Boolean RegisterFont (const Handle< Font_SystemFont > &theFont, const Standard_Boolean theToOverride)
 Register new font. If there is existing entity with the same name and properties but different path then font will be overridden or ignored depending on theToOverride flag. More...
 
Standard_Boolean ToTraceAliases () const
 Return flag for tracing font aliases usage via Message_Trace messages; TRUE by default. More...
 
void SetTraceAliases (Standard_Boolean theToTrace)
 Set flag for tracing font alias usage; useful to trace which fonts are actually used. Can be disabled to avoid redundant messages with Message_Trace level. 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 Handle< Font_FontMgrGetInstance ()
 Return global instance of font manager. More...
 
static const char * FontAspectToString (Font_FontAspect theAspect)
 Return font aspect as string. More...
 
static Standard_BooleanToUseUnicodeSubsetFallback ()
 Return flag to use fallback fonts in case if used font does not include symbols from specific Unicode subset; TRUE by default. 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

Collects and provides information about available fonts in system.

Member Function Documentation

◆ AvailableFonts()

void Font_FontMgr::AvailableFonts ( Font_NListOfSystemFont theList) const
inline

Return the list of available fonts.

◆ CheckFont()

Handle< Font_SystemFont > Font_FontMgr::CheckFont ( const Standard_CString  theFontPath) const

Read font file and retrieve information from it.

◆ FindFallbackFont()

Handle< Font_SystemFont > Font_FontMgr::FindFallbackFont ( Font_UnicodeSubset  theSubset,
Font_FontAspect  theFontAspect 
) const

Tries to find fallback font for specified Unicode subset. Returns NULL in case when fallback font is not found in the system.

Parameters
theSubset[in] Unicode subset
theFontAspect[in] font aspect to find

◆ FindFont() [1/2]

Handle< Font_SystemFont > Font_FontMgr::FindFont ( const TCollection_AsciiString theFontName,
Font_StrictLevel  theStrictLevel,
Font_FontAspect theFontAspect 
) const

Tries to find font by given parameters. If the specified font is not found tries to use font names mapping. If the requested family name not found -> search for any font family with given aspect and height. If the font is still not found, returns any font available in the system. Returns NULL in case when the fonts are not found in the system.

Parameters
theFontName[in] font family to find or alias name
theStrictLevel[in] search strict level for using aliases and fallback
theFontAspect[in] [out] font aspect to find (considered only if family name is not found); can be modified if specified font alias refers to another style (compatibility with obsolete aliases)

◆ FindFont() [2/2]

Handle< Font_SystemFont > Font_FontMgr::FindFont ( const TCollection_AsciiString theFontName,
Font_FontAspect theFontAspect 
) const
inline

Tries to find font by given parameters.

◆ FontAspectToString()

static const char* Font_FontMgr::FontAspectToString ( Font_FontAspect  theAspect)
inlinestatic

Return font aspect as string.

◆ GetAvailableFonts()

Font_NListOfSystemFont Font_FontMgr::GetAvailableFonts ( ) const
inline

Return the list of available fonts.

◆ GetAvailableFontsNames()

void Font_FontMgr::GetAvailableFontsNames ( TColStd_SequenceOfHAsciiString theFontsNames) const

Returns sequence of available fonts names.

◆ GetFont() [1/2]

Handle< Font_SystemFont > Font_FontMgr::GetFont ( const Handle< TCollection_HAsciiString > &  theFontName,
const Font_FontAspect  theFontAspect,
const Standard_Integer  theFontSize 
) const

Returns font that match given parameters. If theFontName is empty string returned font can have any FontName. If theFontAspect is Font_FA_Undefined returned font can have any FontAspect. If theFontSize is "-1" returned font can have any FontSize.

◆ GetFont() [2/2]

Handle< Font_SystemFont > Font_FontMgr::GetFont ( const TCollection_AsciiString theFontName) const

Returns font that match given name or NULL if such font family is NOT registered. Note that unlike FindFont(), this method ignores font aliases and does not look for fall-back.

◆ GetInstance()

static Handle< Font_FontMgr > Font_FontMgr::GetInstance ( )
static

Return global instance of font manager.

◆ RegisterFont()

Standard_Boolean Font_FontMgr::RegisterFont ( const Handle< Font_SystemFont > &  theFont,
const Standard_Boolean  theToOverride 
)

Register new font. If there is existing entity with the same name and properties but different path then font will be overridden or ignored depending on theToOverride flag.

◆ SetTraceAliases()

void Font_FontMgr::SetTraceAliases ( Standard_Boolean  theToTrace)
inline

Set flag for tracing font alias usage; useful to trace which fonts are actually used. Can be disabled to avoid redundant messages with Message_Trace level.

◆ ToTraceAliases()

Standard_Boolean Font_FontMgr::ToTraceAliases ( ) const
inline

Return flag for tracing font aliases usage via Message_Trace messages; TRUE by default.

◆ ToUseUnicodeSubsetFallback()

static Standard_Boolean& Font_FontMgr::ToUseUnicodeSubsetFallback ( )
static

Return flag to use fallback fonts in case if used font does not include symbols from specific Unicode subset; TRUE by default.


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