Mako 7.2.0 API
Loading...
Searching...
No Matches
IEDLClassFactory Class Referenceabstract

EDL Factory Interface allows one part of the EDL infrastructure to register class creation methods identified by either GUIDs and /or names (strings) and then another part of the EDL infrastructure to request the creation of instances of one or more of these classes by quoting the same GUID or name. More...

#include <iedlfactory.h>

Inheritance diagram for IEDLClassFactory:

Public Member Functions

virtual bool registerNamedClass (const EDLSysString &strName, const CClassID &id, bool overwrite=true)=0
 Register a GUID under a string name.
 
virtual bool findNamedClass (const EDLSysString &strName, CClassID &id)=0
 Retrieve GUID registred under the string name.
 
virtual bool registerClass (const CClassID &id, creatorFunc f)=0
 Register a GUID with creator function.
 
virtual IEDLObjectPtr createInstance (const CClassID &id, CClassParams *pParams=NULL)=0
 Creates the registered class by CClassID.
 
virtual IEDLObjectPtr createInstanceJawsMako (const CClassID &id, CClassParams *pParams=NULL, IEDLClassFactory *factory=NULL)=0
 Creates the registered class by CClassID.
 
virtual IEDLObjectPtr getSingleton (const CClassID &id)=0
 Creates the EDL singleton (for example FontLibrary or ColorManager)
 

Detailed Description

EDL Factory Interface allows one part of the EDL infrastructure to register class creation methods identified by either GUIDs and /or names (strings) and then another part of the EDL infrastructure to request the creation of instances of one or more of these classes by quoting the same GUID or name.

EDL Class Factory

Member Function Documentation

◆ createInstance()

virtual IEDLObjectPtr IEDLClassFactory::createInstance ( const CClassID id,
CClassParams pParams = NULL 
)
pure virtual

Creates the registered class by CClassID.

Parameters
idClass GUID
pParamsParameters for class initialization
Returns
IEDLObjectPtr A smart pointer to EDLObject interface to newly created class

◆ createInstanceJawsMako()

virtual IEDLObjectPtr IEDLClassFactory::createInstanceJawsMako ( const CClassID id,
CClassParams pParams = NULL,
IEDLClassFactory factory = NULL 
)
pure virtual

Creates the registered class by CClassID.

Parameters
idClass GUID
pParamsParameters for class initialization
factoryIEDLClassFactory Pointer to JawsMako
Returns
IEDLObjectPtr A smart pointer to EDLObject interface to newly created class

◆ findNamedClass()

virtual bool IEDLClassFactory::findNamedClass ( const EDLSysString &  strName,
CClassID id 
)
pure virtual

Retrieve GUID registred under the string name.

Parameters
strNameName to find
idPlaceholder for result
Returns
bool True on success

◆ getSingleton()

virtual IEDLObjectPtr IEDLClassFactory::getSingleton ( const CClassID id)
pure virtual

Creates the EDL singleton (for example FontLibrary or ColorManager)

Parameters
idClass GUID
Returns
IEDLObjectPtr A smart pointer to the IEDLObject

◆ registerClass()

virtual bool IEDLClassFactory::registerClass ( const CClassID id,
creatorFunc  f 
)
pure virtual

Register a GUID with creator function.

Parameters
idClass GUID
fFunction that creates the class
Returns
bool True on success

◆ registerNamedClass()

virtual bool IEDLClassFactory::registerNamedClass ( const EDLSysString &  strName,
const CClassID id,
bool  overwrite = true 
)
pure virtual

Register a GUID under a string name.

Parameters
strNameName for registartion
idClass GUID
overwriteIf overwrite is true then overwites old name registration else returns false
Returns
bool True on success

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