IDOMFont Class Reference

IDOMFont Base Class. More...

#include <idomfont.h>

Inheritance diagram for IDOMFont:

Classes
class	Data
	Initialization data. More...

Public Types
enum	eFontType {   eFontTypeUnknown , eFontTypeOpenType , eFontType3 , eFontTypePCLXL ,   eFontTypePCL5 }
	type used to uniquely identify the type of font More...
typedef uint32	CharCode
	type used to uniquely identify a character code
typedef std::map< CharCode, IDOMGlyph::GlyphID >	CCharacterMap
	Map type used for storing character code to glyph ID mappings.
Public Types inherited from IDOMFontSource
enum	eFontSourceType { eFontSourceTypeNone , eFontSourceTypeStreamFilter , eFontSourceTypeStream , eFontSourceTypeFont }
	type used to uniquely identify the source type of a font More...

Public Member Functions
virtual eFontType	getFontType () const =0
	Gets the font type. See eFontType for more information on font types. More...
virtual IDOMFontSourcePtr	getFontSource () const =0
	Get the font source of this font. More...
virtual void	setFontSource (const IDOMFontSourcePtr &fontSource)=0
	Sets the font source for this font. More...
virtual IInputStreamPtr	getFontBaseStream () const =0
	Return the base stream for this font, obtaining it from the font source. More...
virtual void	getCharacterMap (CCharacterMap &characterMap, uint32 fontIndex=0U)=0
	Get the character map for this font. More...
Public Member Functions inherited from IDOMFontSource
virtual eFontSourceType	getFontSourceType () const =0
	Gets the font source type. More...
virtual const EDLSysString &	determineUri () const =0
	Determines the URI based on the font source (underlying font sources may be searched) More...
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject. More...
virtual bool	init (CClassParams *pData)
	The init() method is called to perform any post-construction initialization of an IEDLObject that has been created by the EDL class factory, before it is actually returned by the factory. More...
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject. More...
Public Member Functions inherited from IRCObject
virtual void	addRef () const =0
	Increases the reference count of the actual object pointed to. This would take place during an assignment or copying.
virtual bool	decRef () const =0
	Decreases the reference count of the actual object pointed to. When the reference count falls to Zero, it deletes the actual object pointed to. More...
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to. More...
Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.
virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object. More...
virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails. More...

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves class id of IDOMFont. More...
Static Public Member Functions inherited from IDOMFontSource
static const CClassID &	classID ()
	Retrieves the class id of IDOMFontSource. More...

Additional Inherited Members
Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

IDOMFont Base Class.

Member Function Documentation

classID()

static const CClassID& IDOMFont::classID ( )

inlinestatic

Retrieves class id of IDOMFont.

Returns

CClassID class id of the element

getCharacterMap()

virtual void IDOMFont::getCharacterMap ( CCharacterMap &  characterMap, uint32  fontIndex = 0U  )

pure virtual

Get the character map for this font.

Parameters

characterMap	The character map to populate.
fontIndex	The index of the font - only used for TTC fonts.

getFontBaseStream()

virtual IInputStreamPtr IDOMFont::getFontBaseStream ( ) const

pure virtual

Return the base stream for this font, obtaining it from the font source.

Returns

IInputStreamPtr The base stream

getFontSource()

virtual IDOMFontSourcePtr IDOMFont::getFontSource ( ) const

pure virtual

Get the font source of this font.

Returns

IDOMFontSourcePtr The font source.

getFontType()

virtual eFontType IDOMFont::getFontType ( ) const

pure virtual

Gets the font type. See eFontType for more information on font types.

Returns

eFontType. Returns the font type.

setFontSource()

virtual void IDOMFont::setFontSource ( const IDOMFontSourcePtr &  fontSource )

pure virtual

Sets the font source for this font.

Parameters

fontSource

The new font source

---

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

• idomfont.h