Represents the content element of the JobTicket. More...

#include <idomjobtk.h>

Inheritance diagram for IDOMJobTkContent:

[legend]

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual bool	isValid () const =0
	Returns an indicator of the validity of the JobTicket content-that is, whether or not the JobTicket content has been initialised.

virtual void	setLevel (eDOMJobTkLevel level)=0
	Sets the level of the JobTicket content, corresponding to DocumentSequence, FixedDocument or FixedPage (see eDOMJobTkLevel). The default level is eDOMJobTkLevelDefault. The uninitialised value of the level is eDOMJobTkLevelNotValid.

virtual eDOMJobTkLevel	getLevel () const =0
	Retrieves the level of the JobTicket content, corresponding to DocumentSequence, FixedDocument or FixedPage (see eDOMJobTkLevel). The default level is eDOMJobTkLevelDefault. The uninitialised value of the level is eDOMJobTkLevelNotValid.

virtual void	setVersion (double version)=0
	Sets the version of the JobTicket content.

virtual double	getVersion () const =0
	Retrieves the version of the JobTicket content.

virtual void	setModified (bool modified)=0
	Sets the "modified" flag.

virtual bool	getModified () const =0
	Retrieves the value of the "modified" flag.

virtual IDOMJobTkNodePtr	getRootNode ()=0
	Retrieves the root node of the JobTicket content.

virtual IEDLNamespaceCollectionEnumPtr	getNamespaceCollectionEnum ()=0
	Retrieves the enumerator of the namespace collection.

virtual uint32	getNamespacesCount ()=0
	Retrieves the number of namespaces in the namespace collection.

virtual void	clearNamespaceCollection ()=0
	Clears the collection of namespaces.

virtual void	addNamespace (const IEDLNamespacePtr &ptrNamespace)=0
	Appends a namespace to the collection of namespaces. Duplicate namespaces are allowed, providing that they at least have a different prefix. However, in this case only the existing namespace is registered; the new namespace prefix is merely aliased to it, and calling findNamespaceByPrefix() will result in the existing namespace being returned. Completely identical namespaces (prefix and namespace name) will result in an exception.

virtual IEDLNamespacePtr	addNamespace (const EDLSysString &prefix, const EDLSysString &name)=0
	Appends a namespace to the collection of namespaces. Duplicate namespaces are allowed, providing that they at least have a different prefix. However, in this case only the existing namespace is registered; the new namespace prefix is merely aliased to it, and here the existing namespace will be returned. Completely identical namespaces (prefix and namespace name) will result in a null pointer being returned.

virtual IEDLNamespacePtr	findNamespaceByName (const EDLSysString &nmspace)=0
	Finds a namespace in the namespace collection by name.

virtual IEDLNamespacePtr	findNamespaceByPrefix (const EDLSysString &prefix)=0
	Finds a namepace in the namespace collection by prefix.

virtual void	addStandardNamespaces ()=0
	Appends standard print ticket namespaces to the JobTicket content The following standard namespaces are appended: psk="http://schemas.microsoft.com/windows/2003/08/printing/printschemakeywords" xsd="http://www.w3.org/2001/XMLSchema" xsi="http://www.w3.org/2001/XMLSchema-instance" psf="http://schemas.microsoft.com/windows/2003/08/printing/printschemaframework".

virtual EDLQName	convertToQName (const EDLString &name, const EDLSysString &nmspace)=0
	Constructs a qualified name based on a name and namespace provided. The namespace must be present in the namespace collection.

virtual IDOMJobTkNodePtr	findChild (IDOMJobTkNode::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 (IDOMJobTkNode::eDOMJobTkNodeType nodeType, const EDLQName &qname)=0
	Searches through the node's direct child set for a node matching provided the node type and qualified name.

virtual bool	loadFromFile (const EDLSysString &filename)=0
	Loads a JobTicket from a named XML file.

virtual bool	loadFromStream (const IRAInputStreamPtr &xmlStream)=0
	Loads a JobTicket from an XML stream.

virtual bool	loadFromInitString (const EDLSysString &sInit)=0
	Fills the JobTicket using input from the initialisation string.

virtual void	addParameterInit (const IEDLNamespacePtr &parameterNamespace, const EDLSysString &parameterName, const PValue &value)=0
	Adds a <psf:ParameterInit> element to the JobTicket.

virtual void	addFeature (const IEDLNamespacePtr &featureNamespace, const EDLSysString &featureName, const EDLQName &option)=0
	Adds Feature/Option elements to the JobTicket in the format:

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 IDOMNodeFlags *	getFlags ()=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 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 IDOMJobTkContent.

static EDL_API EDLSysString	addToInitString (const EDLSysString &paramName, const EDLSysString &initString, const EDLSysString &paramValue="", bool overwrite=true)
	Static helper to add a key/value pair to an initialisation string. Takes care of escaping as required.

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 the content element of the JobTicket.

Member Function Documentation

◆ addFeature()

virtual void IDOMJobTkContent::addFeature	(	const IEDLNamespacePtr &	featureNamespace,
		const EDLSysString &	featureName,
		const EDLQName &	option )

pure virtual

Adds Feature/Option elements to the JobTicket in the format:

      <psf:Feature name=parameterName>

          <psf:Option name=value/>

      </psf:Feature>

Parameters

featureNamespace	Smart pointer to the feature name namespace.
featureName	Name of feature.
option	Qualified name of feature option.

◆ addNamespace() [1/2]

virtual IEDLNamespacePtr IDOMJobTkContent::addNamespace	(	const EDLSysString &	prefix,
		const EDLSysString &	name )

pure virtual

Appends a namespace to the collection of namespaces. Duplicate namespaces are allowed, providing that they at least have a different prefix. However, in this case only the existing namespace is registered; the new namespace prefix is merely aliased to it, and here the existing namespace will be returned. Completely identical namespaces (prefix and namespace name) will result in a null pointer being returned.

Parameters

prefix	Value of the new namespace prefix
name	Value of the new namespace name

Returns: IEDLNamespacePtr. Smart pointer to the new namespace which has been added, or null on error.

◆ addNamespace() [2/2]

virtual void IDOMJobTkContent::addNamespace ( const IEDLNamespacePtr & ptrNamespace )

pure virtual

Appends a namespace to the collection of namespaces. Duplicate namespaces are allowed, providing that they at least have a different prefix. However, in this case only the existing namespace is registered; the new namespace prefix is merely aliased to it, and calling findNamespaceByPrefix() will result in the existing namespace being returned. Completely identical namespaces (prefix and namespace name) will result in an exception.

Parameters

ptrNamespace Smart pointer to the new namespace.

◆ addParameterInit()

virtual void IDOMJobTkContent::addParameterInit	(	const IEDLNamespacePtr &	parameterNamespace,
		const EDLSysString &	parameterName,
		const PValue &	value )

pure virtual

Adds a <psf:ParameterInit> element to the JobTicket.

Parameters

parameterNamespace	Smart pointer to the parameter namespace.
parameterName	Name of parameter.
value	Value of parameter.

◆ addToInitString()

static EDL_API EDLSysString IDOMJobTkContent::addToInitString	(	const EDLSysString &	paramName,
		const EDLSysString &	initString,
		const EDLSysString &	paramValue = "",
		bool	overwrite = true )

static

Static helper to add a key/value pair to an initialisation string. Takes care of escaping as required.

Parameters

paramName	The parameter name.
initString	The init string to add to
paramValue	The optional parameter value.
overwrite	Determines the behaviour if the parameter is already present in the initString. If true, the existing value will be replaced. If false the value will not be inserted.

Returns: EDLSysString Returns the new init string.

◆ classID()

static const CClassID & IDOMJobTkContent::classID ( )

inlinestatic

Retrieves the class id of IDOMJobTkContent.

Returns: CClassID. Returns the class id of the element.

◆ convertToQName()

virtual EDLQName IDOMJobTkContent::convertToQName	(	const EDLString &	name,
		const EDLSysString &	nmspace )

pure virtual

Constructs a qualified name based on a name and namespace provided. The namespace must be present in the namespace collection.

Parameters

name	Name of JobTicket content element
nmspace	Namespace of JobTicket content element

Returns: EDLQName The constructed qualified name.

◆ findChild() [1/2]

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

pure virtual

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

Parameters

nodeType	Job ticket node type.
qname	Qualified name of JobTicket node.

Returns: IDOMJobTkNodePtr. Returns smart pointer to the retrieved JobTicket node.

◆ findChild() [2/2]

virtual IDOMJobTkNodePtr IDOMJobTkContent::findChild	(	IDOMJobTkNode::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

nodeType	Job ticket node type.
name	Name of JobTicket node.
nmspace	Namespace of JobTicket node.

Returns: IDOMJobTkNodePtr. Returns smart pointer to the retrieved JobTicket node.

◆ findNamespaceByName()

virtual IEDLNamespacePtr IDOMJobTkContent::findNamespaceByName ( const EDLSysString & nmspace )

pure virtual

Finds a namespace in the namespace collection by name.

Parameters

nmspace Value of namespace name.

Returns: IEDLNamespacePtr A smart pointer to the the namespace that was found.

◆ findNamespaceByPrefix()

virtual IEDLNamespacePtr IDOMJobTkContent::findNamespaceByPrefix ( const EDLSysString & prefix )

pure virtual

Finds a namepace in the namespace collection by prefix.

Parameters

prefix Value of namespace prefix.

Returns: IEDLNamespacePtr Smart pointer to the namespace that was found

◆ getLevel()

virtual eDOMJobTkLevel IDOMJobTkContent::getLevel ( ) const

pure virtual

Retrieves the level of the JobTicket content, corresponding to DocumentSequence, FixedDocument or FixedPage (see eDOMJobTkLevel). The default level is eDOMJobTkLevelDefault. The uninitialised value of the level is eDOMJobTkLevelNotValid.

Returns: eDOMJobTkLevel. Returns the level of the JobTicket content.

◆ getModified()

virtual bool IDOMJobTkContent::getModified ( ) const

pure virtual

Retrieves the value of the "modified" flag.

Returns: bool. Value of the "modified" flag.

◆ getNamespaceCollectionEnum()

virtual IEDLNamespaceCollectionEnumPtr IDOMJobTkContent::getNamespaceCollectionEnum ( )

pure virtual

Retrieves the enumerator of the namespace collection.

Returns: IEDLNamespaceCollectionEnumPtr. Returns a pointer to the enumerator.

◆ getNamespacesCount()

virtual uint32 IDOMJobTkContent::getNamespacesCount ( )

pure virtual

Retrieves the number of namespaces in the namespace collection.

Returns: uint32 Returns the number of namespaces in the collection.

◆ getRootNode()

virtual IDOMJobTkNodePtr IDOMJobTkContent::getRootNode ( )

pure virtual

Retrieves the root node of the JobTicket content.

Returns: IDOMJobTkNodePtr The root node.

◆ getVersion()

virtual double IDOMJobTkContent::getVersion ( ) const

pure virtual

Retrieves the version of the JobTicket content.

Returns: double. Returns the version of the JobTicket content.

◆ isValid()

virtual bool IDOMJobTkContent::isValid ( ) const

pure virtual

Returns an indicator of the validity of the JobTicket content-that is, whether or not the JobTicket content has been initialised.

Returns: bool Returns true if the content has been initialised, false otherwise.

◆ loadFromFile()

virtual bool IDOMJobTkContent::loadFromFile ( const EDLSysString & filename )

pure virtual

Loads a JobTicket from a named XML file.

Parameters

filename Path to and name of the JobTicket file to load

Returns: bool. Returns true on success, or false if the call fails.

◆ loadFromInitString()

virtual bool IDOMJobTkContent::loadFromInitString ( const EDLSysString & sInit )

pure virtual

Fills the JobTicket using input from the initialisation string.

Parameters

sInit Initialisation string.

Returns: bool. Returns true on success, or false if the call fails.

◆ loadFromStream()

virtual bool IDOMJobTkContent::loadFromStream ( const IRAInputStreamPtr & xmlStream )

pure virtual

Loads a JobTicket from an XML stream.

Parameters

xmlStream Stream for xml data

Returns: bool. Returns true on success, or false if the call fails.

◆ setLevel()

virtual void IDOMJobTkContent::setLevel ( eDOMJobTkLevel level )

pure virtual

Sets the level of the JobTicket content, corresponding to DocumentSequence, FixedDocument or FixedPage (see eDOMJobTkLevel). The default level is eDOMJobTkLevelDefault. The uninitialised value of the level is eDOMJobTkLevelNotValid.

Parameters

level Job ticket level.

◆ setModified()

virtual void IDOMJobTkContent::setModified ( bool modified )

pure virtual

Sets the "modified" flag.

Parameters

modified New value of the "modified" flag.

◆ setVersion()

virtual void IDOMJobTkContent::setVersion ( double version )

pure virtual

Sets the version of the JobTicket content.

Parameters

version Job ticket version.

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

idomjobtk.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ addFeature()

◆ addNamespace() [1/2]

◆ addNamespace() [2/2]

◆ addParameterInit()

◆ addToInitString()

◆ classID()

◆ convertToQName()

◆ findChild() [1/2]

◆ findChild() [2/2]

◆ findNamespaceByName()

◆ findNamespaceByPrefix()

◆ getLevel()

◆ getModified()

◆ getNamespaceCollectionEnum()

◆ getNamespacesCount()

◆ getRootNode()

◆ getVersion()

◆ isValid()

◆ loadFromFile()

◆ loadFromInitString()

◆ loadFromStream()

◆ setLevel()

◆ setModified()

◆ setVersion()