Mako 7.4.0 API
Loading...
Searching...
No Matches
IDOMJobTkNode Class Referenceabstract

Represents a Job Ticket Node. More...

#include <idomjobtk.h>

Inheritance diagram for IDOMJobTkNode:

Classes

class  Data
 Initialization data. More...
 

Public Types

enum  eDOMJobTkNodeType
 DOMJobTk node (Property, Feature, Option, InitParam, ScoredProperty, ParamRef)
 

Public Member Functions

virtual void setQName (const EDLQName &qname)=0
 Sets the qualified name of the node.
 
virtual EDLQName getQName () const =0
 Retrieves the node qname.
 
virtual EDLString getQNameAsString () const =0
 Retrieves the full qualified name of the node as a string.
 
virtual void setJobTkNodeType (eDOMJobTkNodeType nodeType)=0
 Sets the node type.
 
virtual eDOMJobTkNodeType getJobTkNodeType ()=0
 Retrieves the node type.
 
virtual IDOMJobTkContentPtr getJobTkContent ()=0
 Returns the JobTicket content of this node, by following up the parent node chain.
 
virtual IDOMJobTkValuePtr getChildValue ()=0
 If JobTicket node has child with type eDOMJobTkPTNodeValue then returns this child, otherwise returns NULL.
 
virtual IDOMJobTkNodePtr findChild (eDOMJobTkNodeType nodeType, const EDLString &name, const EDLSysString &nmspace)=0
 Searches through the node's direct child set for a node matching the provided node type, name and namespace.
 
virtual IDOMJobTkNodePtr findChild (eDOMJobTkNodeType nodeType, const EDLQName &qname)=0
 Searches through the node's direct child set for a node matching the provided node type and qname.
 
- Public Member Functions inherited from IDOMNode
virtual ~IDOMNode ()
 virtual destructor
 
virtual DOMid getDOMid () const =0
 Retrieves the node ID.
 
virtual void setDOMid (DOMid id)=0
 Sets the node ID.
 
virtual eDOMNodeType getNodeType () const =0
 Retrieves the DOM node type.
 
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.
 
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.
 
virtual void removeProperty (const EDLSysString &propertyName)=0
 Removes property.
 
virtual IEDLSysStringCollectionEnumPtr getPropertyCollectionEnum ()=0
 Retrieves a navigable list of the property names stored on this node.
 
virtual bool hasChildNodes () const =0
 Function that indicates whether this node is a parent to other nodes.
 
virtual IDOMNodePtr getParentNode () const =0
 Gets the parent node of this node.
 
virtual IDOMNodePtr getFirstChild () const =0
 Gets the first child node of this node.
 
virtual IDOMNodePtr getLastChild () const =0
 Gets the last child node of this node.
 
virtual IDOMNodePtr getNextChild (const IDOMNodePtr &child) const =0
 Gets the child node which follows the node passed in.
 
virtual IDOMNodePtr getPreviousChild (const IDOMNodePtr &child) const =0
 Gets the child node which precedes the node passed in.
 
virtual IDOMNodePtr getPreviousSibling () const =0
 Retrieves the node's previous sibling node.
 
virtual IDOMNodePtr getNextSibling () const =0
 Retrieves node's next sibling node.
 
virtual void appendChild (const IDOMNodePtr &child)=0
 Appends a node to the end of the node's child list.
 
virtual void insertChild (const IDOMNodePtr &ptrPreviousSibling, const IDOMNodePtr &child, bool bCheckComplete=true)=0
 Insert a child node after ptrPreviousSibling.
 
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.
 
virtual void replaceChild (const IDOMNodePtr &oldChild, const IDOMNodePtr &newChild)=0
 Replaces the child node with another.
 
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.
 
virtual void setComplete ()=0
 Sets the node's completeness status to "true".
 
virtual IDOMNodeFlagsgetFlags ()=0
 Retrieves the node's flags property.
 
virtual void setParentNode (const IDOMNodePtr &ptrParent)=0
 Sets the parent node.
 
virtual void setPreviousSibling (const IDOMNodePtr &ptrPreviousSibling)=0
 Sets the previous sibling node.
 
virtual void setNextSibling (const IDOMNodePtr &ptrNextSibling)=0
 Sets the next sibling node.
 
virtual bool isAncestor (const IDOMNodePtr &ptrCandidate)=0
 Function tests whether a candidate node is a descendant of the node.
 
virtual FRect getBounds (bool applyTransform=true, bool applyClip=true)
 Find the conservative bounding box of the marking content of the node.
 
virtual bool copyNodeData (IDOMNode *pSourceNode)=0
 Copy the properties collection, the flags and the DOM ID from the given source node to this one.
 
virtual IDOMNodePtr cloneNode (IEDLClassFactory *pFactory) const =0
 Simpified node cloning. An exception of type IEDLError will be thrown on failure.
 
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.
 
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.
 
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.
 
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:
 
virtual void notifyOnDestruct (NodeDeleteFunc func, void *priv)=0
 Register interest in being told when this node is about to be destroyed.
 
virtual void unregisterNotify (NodeDeleteFunc func, void *priv)=0
 Unregister interest in being told when this node is about to be destroyed.
 
- Public Member Functions inherited from IEDLObject
virtual const CClassIDgetClassID () 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 CClassIDclassID ()
 Retrieves the class id of IDOMJobTk.
 
- 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.
 

Additional Inherited Members

- Protected Member Functions inherited from IRCObject
virtual ~IRCObject ()
 Virtual destructor.
 

Detailed Description

Represents a Job Ticket Node.

Member Function Documentation

◆ classID()

static const CClassID & IDOMJobTkNode::classID ( )
inlinestatic

Retrieves the class id of IDOMJobTk.

Returns
CClassID. Class id of the element

◆ findChild() [1/2]

virtual IDOMJobTkNodePtr IDOMJobTkNode::findChild ( eDOMJobTkNodeType nodeType,
const EDLQName & qname )
pure virtual

Searches through the node's direct child set for a node matching the provided node type and qname.

Parameters
nodeTypeJob ticket node type.
qnameQualified name of JobTicket node.
Returns
IDOMJobTkNodePtr. Smart pointer to the found JobTicket node

◆ findChild() [2/2]

virtual IDOMJobTkNodePtr IDOMJobTkNode::findChild ( eDOMJobTkNodeType nodeType,
const EDLString & name,
const EDLSysString & nmspace )
pure virtual

Searches through the node's direct child set for a node matching the provided node type, name and namespace.

Parameters
nodeTypeJob ticket node type.
nameName of JobTicket node.
nmspaceNamespace of JobTicket node.
Returns
IDOMJobTkNodePtr. Smart pointer to the found JobTicket node

◆ getChildValue()

virtual IDOMJobTkValuePtr IDOMJobTkNode::getChildValue ( )
pure virtual

If JobTicket node has child with type eDOMJobTkPTNodeValue then returns this child, otherwise returns NULL.

Returns
IDOMJobTkValuePtr. Smart pointer to the JobTicket value node interface

◆ getJobTkContent()

virtual IDOMJobTkContentPtr IDOMJobTkNode::getJobTkContent ( )
pure virtual

Returns the JobTicket content of this node, by following up the parent node chain.

Returns
IDOMJobTkContentPtr. Smart pointer to the JobTicket content interface

◆ getJobTkNodeType()

virtual eDOMJobTkNodeType IDOMJobTkNode::getJobTkNodeType ( )
pure virtual

Retrieves the node type.

Returns
eDOMJobTkNodeType. Returns the node type.

◆ getQName()

virtual EDLQName IDOMJobTkNode::getQName ( ) const
pure virtual

Retrieves the node qname.

Returns
EDLQName Qualified name value

◆ getQNameAsString()

virtual EDLString IDOMJobTkNode::getQNameAsString ( ) const
pure virtual

Retrieves the full qualified name of the node as a string.

Returns
EDLString The node's qualified name as a string.

◆ setJobTkNodeType()

virtual void IDOMJobTkNode::setJobTkNodeType ( eDOMJobTkNodeType nodeType)
pure virtual

Sets the node type.

Parameters
nodeTypeThe node type. See eDOMJobTkNodeType.

◆ setQName()

virtual void IDOMJobTkNode::setQName ( const EDLQName & qname)
pure virtual

Sets the qualified name of the node.

URI references can contain characters not allowed in names, and are often inconveniently long, so expanded names are not used directly to name elements and attributes in XML documents. Instead qualified names are used. A qualified name is a name subject to namespace interpretation.

Parameters
qnameQualified name value

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