IDOMResourceDictionary Class Reference

Interface to the EDL DOM's resource dictionary. The resource dictionary is a document resource that is shared between page markups. It holds a reference list of non-markup content that is shared between multiple pages of the document. More...

#include <edl/idomresources.h>

Inheritance diagram for IDOMResourceDictionary:

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual IEDLObjectPtr	get (const EDLSysString &name) const =0
	Retrieves a smart pointer to a resource stored in the resource dictionary.
virtual void	put (const EDLSysString &name, const IEDLObjectPtr &element)=0
	Registers a resource element in the resource dictionary.
Public Member Functions inherited from IDOMResource
virtual IInputStreamPtr	getStream () const =0
	Retrieves the resource stream.
virtual void	setStream (const IInputStreamPtr &stream)=0
	Sets the resource stream for the node.
virtual uint64	getStreamLength () const =0
	Retrieves the stream length, if it is available.
virtual const EDLSysString &	getUri () const =0
	Retrieves the resource URI.
virtual void	setUri (const EDLSysString &uri)=0
	Sets the resource URI.
Public Member Functions inherited from IEDLObject
virtual const CClassID &	getClassID () const =0
	Returns class ID of IEDLObject.
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.
virtual bool	clone (IEDLObjectPtr &ptrObject, IEDLClassFactory *pFactory)
	Create a copy of EDLObject.
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.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.

Static Public Member Functions
static const CClassID &	classID ()
	Retrieves the class id of IDOMResourceDictionary.

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

Detailed Description

Interface to the EDL DOM's resource dictionary. The resource dictionary is a document resource that is shared between page markups. It holds a reference list of non-markup content that is shared between multiple pages of the document.

Member Function Documentation

classID()

const CClassID & IDOMResourceDictionary::classID ( )

inlinestatic

Retrieves the class id of IDOMResourceDictionary.

Returns

CClassID. Returns the class id of the element

get()

virtual IEDLObjectPtr IDOMResourceDictionary::get ( const EDLSysString & name ) const

pure virtual

Retrieves a smart pointer to a resource stored in the resource dictionary.

Parameters

name	The name of the resource to be retrieved.

Returns

IEDLObjectPtr. A smart pointer to the resource (as an IEDLObject pointer).

put()

virtual void IDOMResourceDictionary::put ( const EDLSysString & name, const IEDLObjectPtr & element )

pure virtual

Registers a resource element in the resource dictionary.

Parameters

name	The name of the resource to add.
element	Smart pointer to an IEDLObject representing the resource.

---

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

• edl/idomresources.h