IDOMFormInstance interface. This describes an instance of an IDOMForm in a DOM tree. More...

#include <idomform.h>

Inheritance diagram for IDOMFormInstance:

[legend]

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual float	getOpacity () const =0
	Get the form alpha/opacity. More...

virtual void	setOpacity (float opacity)=0
	Set the form alpha/opacity. More...

virtual const FMatrix &	getRenderTransform () const =0
	Retrieves render transform applied to this instance of the form. More...

virtual void	setRenderTransform (const FMatrix &renderTransform)=0
	Retrieves render transform applied to this instance of the form. More...

virtual IDOMFormPtr	getForm () const =0
	Retrieves the Form associated with this instance. More...

virtual void	setForm (const IDOMFormPtr &form)=0
	Sets the Form associated with this instance. More...

virtual eBlendMode	getBlendMode () const =0
	Get the blend mode to be used for compositing this form. More...

virtual void	setBlendMode (eBlendMode blendMode)=0
	Set the blend mode to be used for compositing this form. More...

virtual IDOMBrushPtr	getOpacityMask () const =0
	Retrieves smart pointer to opacity mask. More...

virtual void	setOpacityMask (const IDOMBrushPtr &ptrOpacityMask)=0
	Sets the opacity mask. More...

Public Member Functions inherited from IDOMNode
virtual	~IDOMNode ()
	virtual destructor

virtual DOMid	getDOMid () const =0
	Retrieves the node ID. More...

virtual void	setDOMid (DOMid id)=0
	Sets the node ID. More...

virtual eDOMNodeType	getNodeType () const =0
	Retrieves the DOM node type. More...

virtual bool	getProperty (const EDLSysString &propertyName, PValue &propertyValue) const =0
	Retrieves the value of a property. The EDL DOM node can store non-content or relationship information through the use of the "properties" feature of the node. The data is represented as key-value pairs; the key being a string and the value being an abstract container called a PValue. PValues can represent integers, strings, DOM nodes, and so on. More...

virtual void	setProperty (const EDLSysString &propertyName, const PValue &propertyValue)=0
	Sets the value of a property. The EDL DOM node can store non-content or relationship information through the use of the "properties" feature of the node. The data is represented as key-value pairs; the key being a string and the value being an abstract container called a PValue. PValues can represent integers, strings, DOM nodes, and so on. More...

virtual void	removeProperty (const EDLSysString &propertyName)=0
	Removes property. More...

virtual IEDLSysStringCollectionEnumPtr	getPropertyCollectionEnum ()=0
	Retrieves a navigable list of the property names stored on this node. More...

virtual bool	hasChildNodes () const =0
	Function that indicates whether this node is a parent to other nodes. More...

virtual IDOMNodePtr	getParentNode () const =0
	Gets the parent node of this node. More...

virtual IDOMNodePtr	getFirstChild () const =0
	Gets the first child node of this node. More...

virtual IDOMNodePtr	getLastChild () const =0
	Gets the last child node of this node. More...

virtual IDOMNodePtr	getNextChild (const IDOMNodePtr &child) const =0
	Gets the child node which follows the node passed in. More...

virtual IDOMNodePtr	getPreviousChild (const IDOMNodePtr &child) const =0
	Gets the child node which precedes the node passed in. More...

virtual IDOMNodePtr	getPreviousSibling () const =0
	Retrieves the node's previous sibling node. More...

virtual IDOMNodePtr	getNextSibling () const =0
	Retrieves node's next sibling node. More...

virtual void	appendChild (const IDOMNodePtr &child)=0
	Appends a node to the end of the node's child list. More...

virtual void	insertChild (const IDOMNodePtr &ptrPreviousSibling, const IDOMNodePtr &child, bool bCheckComplete=true)=0
	Insert a child node after ptrPreviousSibling. More...

virtual IDOMNodePtr	extractChild (const IDOMNodePtr &child)=0
	Extracts (that is, finds and removes) a child node from the node children. After extraction the child node is no longer a part of the DOM. If no node is specified, the first available node will be extracted from the node's children. More...

virtual void	replaceChild (const IDOMNodePtr &oldChild, const IDOMNodePtr &newChild)=0
	Replaces the child node with another. More...

virtual bool	isComplete () const =0
	Signals the completeness of the node. A complete node is one that has no more children to be added to it. More...

virtual void	setComplete ()=0
	Sets the node's completeness status to "true".

virtual IDOMNodeFlags *	getFlags ()=0
	Retrieves the node's flags property. More...

virtual void	setParentNode (const IDOMNodePtr &ptrParent)=0
	Sets the parent node. More...

virtual void	setPreviousSibling (const IDOMNodePtr &ptrPreviousSibling)=0
	Sets the previous sibling node. More...

virtual void	setNextSibling (const IDOMNodePtr &ptrNextSibling)=0
	Sets the next sibling node. More...

virtual bool	isAncestor (const IDOMNodePtr &ptrCandidate)=0
	Function tests whether a candidate node is a descendant of the node. More...

virtual FRect	getBounds (bool applyTransform=true, bool applyClip=true)
	Find the conservative bounding box of the marking content of the node. More...

virtual bool	copyNodeData (IDOMNode *pSourceNode)=0
	Copy the properties collection, the flags and the DOM ID from the given source node to this one. More...

virtual IDOMNodePtr	cloneNode (IEDLClassFactory *pFactory) const =0
	Simpified node cloning. An exception of type IEDLError will be thrown on failure. More...

virtual IDOMNodePtr	cloneTree (IEDLClassFactory *pFactory) const =0
	Clone the tree of nodes beginning at this node. An exception of type IEDLError will be thrown on failure. More...

virtual void	cloneTreeAndAppend (IEDLClassFactory *pFactory, const IDOMNodePtr &dest) const =0
	Clone the tree of nodes beginning at this node, and append the result to the destination tree. More...

virtual void	completeTree ()=0
	Mark the entire tree from this point as complete. You should not ordinarily need to call this function.

virtual void	removeCompleteFlagFromTree ()=0
	Mark the entire tree from this point as complete.

virtual void	findChildrenOfType (eDOMNodeType type, CDOMNodeVect &nodes, bool searchForms=false)=0
	Find all children of this node with the given type, appending to the given vector. Does not descend into brushes. More...

virtual void	walkTree (WalkTreeFunc func, void *priv, bool descendIntoBrushes=false, bool descendIntoForms=false)=0
	Walk through the DOM calling a given function on each node. The function is allowed to: More...

virtual void	notifyOnDestruct (NodeDeleteFunc func, void *priv)=0
	Register interest in being told when this node is about to be destroyed. More...

virtual void	unregisterNotify (NodeDeleteFunc func, void *priv)=0
	Unregister interest in being told when this node is about to be destroyed. 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...

Static Public Member Functions
static EDL_API IDOMFormInstancePtr	create (IEDLClassFactory *pFactory, const IDOMFormPtr &form, const FMatrix &renderTransform=FMatrix())
	Simplified creation function for IDOMFormInstance. Throws an IEDLError exception on failure. More...

static const CClassID &	classID ()
	Retrieves class id of IDOMForm. More...

Static Public Member Functions inherited from IDOMNode
static EDL_API FMatrix	effectiveTransformationOfNode (const IDOMNodePtr &node)
	Attempt to find the effective transformation matrix external to the specified node relative to either a containing page or ultimate parent. More...

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

Detailed Description

IDOMFormInstance interface. This describes an instance of an IDOMForm in a DOM tree.

Member Function Documentation

◆ classID()

static const CClassID& IDOMFormInstance::classID ( )

inlinestatic

Retrieves class id of IDOMForm.

Returns: CClassID class id of the element

◆ create()

static EDL_API IDOMFormInstancePtr IDOMFormInstance::create	(	IEDLClassFactory *	pFactory,
		const IDOMFormPtr &	form,
		const FMatrix &	renderTransform = `FMatrix()`
	)

static

Simplified creation function for IDOMFormInstance. Throws an IEDLError exception on failure.

Parameters

pFactory	The EDL class factory.
form	The form that this instance will use.
renderTransform	The desired render transform.

Returns: IDOMFormInstancePtr A smart pointer to the IDOMForm.

◆ getBlendMode()

virtual eBlendMode IDOMFormInstance::getBlendMode ( ) const

pure virtual

Get the blend mode to be used for compositing this form.

Returns: eBlendMode The blend mode for this form

◆ getForm()

virtual IDOMFormPtr IDOMFormInstance::getForm ( ) const

pure virtual

Retrieves the Form associated with this instance.

Returns: IDOMFormPtr The form or NULL if no form is present in the instance.

◆ getOpacity()

virtual float IDOMFormInstance::getOpacity ( ) const

pure virtual

Get the form alpha/opacity.

Returns: float The opacity.

◆ getOpacityMask()

virtual IDOMBrushPtr IDOMFormInstance::getOpacityMask ( ) const

pure virtual

Retrieves smart pointer to opacity mask.

Returns: IDOMBrushPtr The opacity mask for this form or NULL if no opacity mask is present.

◆ getRenderTransform()

virtual const FMatrix& IDOMFormInstance::getRenderTransform ( ) const

pure virtual

Retrieves render transform applied to this instance of the form.

Returns: FMatrix The render transform

◆ setBlendMode()

virtual void IDOMFormInstance::setBlendMode ( eBlendMode blendMode )

pure virtual

Set the blend mode to be used for compositing this form.

Parameters

blendMode The desired blend mode

◆ setForm()

virtual void IDOMFormInstance::setForm ( const IDOMFormPtr & form )

pure virtual

Sets the Form associated with this instance.

Parameters

form	Reference to the desired form.

◆ setOpacity()

virtual void IDOMFormInstance::setOpacity ( float opacity )

pure virtual

Set the form alpha/opacity.

Parameters

opacity The desired opacity, a value between 0.0 and 1.0

◆ setOpacityMask()

virtual void IDOMFormInstance::setOpacityMask ( const IDOMBrushPtr & ptrOpacityMask )

pure virtual

Sets the opacity mask.

Parameters

ptrOpacityMask Smart pointer to desired opacity mask

◆ setRenderTransform()

virtual void IDOMFormInstance::setRenderTransform ( const FMatrix & renderTransform )

pure virtual

Retrieves render transform applied to this instance of the form.

Parameters

renderTransform Reference to the desired transform

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

idomform.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ create()

◆ getBlendMode()

◆ getForm()

◆ getOpacity()

◆ getOpacityMask()

◆ getRenderTransform()

◆ setBlendMode()

◆ setForm()

◆ setOpacity()

◆ setOpacityMask()

◆ setRenderTransform()