A canvas is a special form of an isolated, non-knockout, normal blended transparency group. More...

#include <idomcanvas.h>

Inheritance diagram for IDOMCanvas:

[legend]

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual EDLString	getLanguage () const =0
	Retrieves the default language of the <Canvas> element and any of its children. More...

virtual void	setLanguage (const EDLString &lang)=0
	Sets the default language of the <Canvas> element and any of its children. More...

virtual EDLString	getAutomationPropertiesName () const =0
	Retrieves the automation properties name of the <Canvas> element. More...

virtual void	setAutomationPropertiesName (const EDLString &propname)=0
	Sets the automation properties name of the <Canvas> element. More...

virtual EDLString	getAutomationPropertiesHelpText () const =0
	Retrieves the automation properties help text of the <Canvas> element. More...

virtual void	setAutomationPropertiesHelpText (const EDLString &helptext)=0
	Sets automation properties help text of the <Canvas> element. More...

virtual eEdgeMode	getEdgeMode () const =0
	Retrieves render options edge mode of the <Canvas> element. More...

virtual void	setEdgeMode (eEdgeMode em)=0
	Sets render the options edge mode of the <Canvas> element. More...

virtual IDOMTargetPtr	getNavigateLink () const =0
	Retrieves the target of a hyperlink. More...

virtual void	setNavigateLink (const IDOMTargetPtr &target)=0
	Sets the target of a hyperlink. More...

virtual IDOMResourceDictionaryPtr	getResourceDictionary () const =0
	Retrieves a smart pointer to the resource dictionary. More...

virtual void	setResourceDictionary (const IDOMResourceDictionaryPtr &ptrResourceDictionary)=0
	Sets the resource dictionary. More...

Public Member Functions inherited from IDOMTransparencyGroup
virtual float	getOpacity () const =0
	Get the group alpha/opacity. More...

virtual void	setOpacity (float opacity)=0
	Set the group opacity. More...

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

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

virtual IDOMColorSpacePtr	getColorSpace () const =0
	Get the group colorspace. More...

virtual void	setColorSpace (const IDOMColorSpacePtr &colorSpace)=0
	Set the group colorspace. More...

virtual bool	getIsIsolated () const =0
	Is the group an isolated group? See section 7.5.5 of the PDF 1.7 spec for details. More...

virtual void	setIsIsolated (bool isolated)=0
	Set whether the group is isolated. See section 7.5.5 of the PDF 1.7 spec for details. More...

virtual bool	getIsKnockout () const =0
	Is the group a knockout group? See section 7.5.5 of the PDF 1.7 spec for details. More...

virtual void	setIsKnockout (bool knockout)=0
	Set whether the group is a knockout group. See section 7.5.5 of the PDF 1.7 spec for details. More...

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

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

Public Member Functions inherited from IDOMGroup
virtual const FMatrix &	getRenderTransform () const =0
	Retrieves render transform matrix of the Group and its children. More...

virtual void	setRenderTransform (const FMatrix &matrix)=0
	Sets render transform matrix of the Group and its children. More...

virtual IDOMPathGeometryPtr	getClip () const =0
	Retrieves smart pointer to the clip. More...

virtual void	setClip (const IDOMPathGeometryPtr &ptrClip)=0
	Sets clip. More...

virtual JawsMako::IOptionalContentDetailsPtr	getOptionalContentDetails () const =0
	Get the JawsMako Optional Content details, or NULL if the group is not subject to optional content. More...

virtual void	setOptionalContentDetails (const JawsMako::IOptionalContentDetailsPtr &details)=0
	Set the JawsMako Optional Content details for the group, or NULL to remove. Note that this is only allowed for bare IDOMGroup objects and not for subclasses. Any attempt to set optional content details on any object that is not an IDOMGroup (getNodeType() is eDOMGroupNode) will result in an exception. Note that an IDOMGroup may have optional content details or marked content details, but not both. More...

virtual JawsMako::IMarkedContentDetailsPtr	getMarkedContentDetails () const =0
	Get the JawsMako Marked Content details for this group, or NULL if the group is not marked. More...

virtual void	setMarkedContentDetails (const JawsMako::IMarkedContentDetailsPtr &details)=0
	Set the JawsMako Marked Content details for this group, or NULL to remove. Note that this is only allowed for bare IDOMGroup objects and not for subclasses. Any attempt to set marked content details on any object that is not an IDOMGroup (getNodeType() is eDOMGroupNode) will result in an exception. Note that an IDOMGroup may have optional content details or marked content details, but not both. 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 const CClassID &	classID ()
	Retrieves the class id of IDOMCanvas. More...

Static Public Member Functions inherited from IDOMTransparencyGroup
static const CClassID &	classID ()
	Retrieves class id of IDOMTransparencyGroup. More...

static EDL_API IDOMTransparencyGroupPtr	create (IEDLClassFactory *pFactory, const FMatrix &transform=FMatrix(), const IDOMPathGeometryPtr &clip=IDOMPathGeometryPtr(), float opacity=1.0f, const IDOMBrushPtr &opacityMask=IDOMBrushPtr(), eBlendMode blendMode=eBlendModeNormal, const IDOMColorSpacePtr &colorSpace=IDOMColorSpacePtr(), bool isolated=false, bool knockout=false)
	Simplified creation function for IDOMGroup. Throws an IEDLError exception on failure. More...

Static Public Member Functions inherited from IDOMGroup
static EDL_API IDOMGroupPtr	create (IEDLClassFactory *pFactory, const FMatrix &transform=FMatrix(), const IDOMPathGeometryPtr &clip=IDOMPathGeometryPtr())
	Simplified creation function for IDOMGroup. Throws an IEDLError exception on failure. More...

static const CClassID &	classID ()
	Retrieves class id of IDOMGroup. 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

A canvas is a special form of an isolated, non-knockout, normal blended transparency group.

A Canvas groups other elements of a page together. For example, Glyphs and Paths can be grouped in a Canvas in order to be identified as a unit or to apply a composed property value to each child and its ancestor.

Some properties of the Canvas element, including the coordinate space of the canvas, are composable and affect the rendering of child elements.

The RenderOptionsEdgeMode property can be set in the Canvas node to instruct anti-aliasing consumers to render the contents of the Canvas node and all child and descendant nodes without performing anti-aliasing.

Member Function Documentation

◆ classID()

static const CClassID& IDOMCanvas::classID ( )

inlinestatic

Retrieves the class id of IDOMCanvas.

Returns: CClassID Class id of the element

◆ getAutomationPropertiesHelpText()

virtual EDLString IDOMCanvas::getAutomationPropertiesHelpText ( ) const

pure virtual

Retrieves the automation properties help text of the <Canvas> element.

The automation properties help text of a canvas is a more detailed description of the canvas content for accessibility purposes. This is particularly useful if the canvas is filled with a set of vector graphics and text elements intended to comprise a single vector graphic. For example, "This is a picture of the Earth."

Returns: EDLString. Returns the automation properties help text.

◆ getAutomationPropertiesName()

virtual EDLString IDOMCanvas::getAutomationPropertiesName ( ) const

pure virtual

Retrieves the automation properties name of the <Canvas> element.

The automation properties name is a brief description of the <Canvas> content for accessibility purposes, particularly if the canvas is filled with a set of vector graphics and text elements intended to comprise a single vector graphic.

Returns: EDLString. Returns the automation properties name.

◆ getEdgeMode()

virtual eEdgeMode IDOMCanvas::getEdgeMode ( ) const

pure virtual

Retrieves render options edge mode of the <Canvas> element.

Render options edge mode controls how edges of paths within the canvas are rendered. The only valid value for render options edge mode is Aliased. Omitting this attribute causes the edges to be rendered in the consumer's default manner

Returns: eEdgeMode. The function returns the edge mode of the canvas.

◆ getLanguage()

virtual EDLString IDOMCanvas::getLanguage ( ) const

pure virtual

Retrieves the default language of the <Canvas> element and any of its children.

English is defined as en_GB and American English as en_US. There is no default setting. If the language is not known it is set to und (undetermined). For further information see http://www.w3.org/International/articles/language-tags/.

The language is specified according to RFC 3066.

Returns: EDLString. Returns the language setting of the <Canvas> element

◆ getNavigateLink()

virtual IDOMTargetPtr IDOMCanvas::getNavigateLink ( ) const

pure virtual

Retrieves the target of a hyperlink.

Returns: IDOMTargetPtr. Returns the target of the hyperlink

◆ getResourceDictionary()

virtual IDOMResourceDictionaryPtr IDOMCanvas::getResourceDictionary ( ) const

pure virtual

Retrieves a smart pointer to the resource dictionary.

The resource dictionary contains the IDs of resources stored at this level of the document.

Returns: IIDOMResourceDictionaryPtr. Returns a smart pointer to the resource dictionary.

◆ setAutomationPropertiesHelpText()

virtual void IDOMCanvas::setAutomationPropertiesHelpText ( const EDLString & helptext )

pure virtual

Sets automation properties help text of the <Canvas> element.

The automation properties help text of a canvas is a more detailed description of the canvas content for accessibility purposes. This is particularly useful if the canvas is filled with a set of vector graphics and text elements intended to comprise a single vector graphic. For example, "This is a picture of the Earth."

Parameters

helptext The new automation properties help text.

◆ setAutomationPropertiesName()

virtual void IDOMCanvas::setAutomationPropertiesName ( const EDLString & propname )

pure virtual

Sets the automation properties name of the <Canvas> element.

The automation properties name is a brief description of the <Canvas> content for accessibility purposes, particularly if the canvas is filled with a set of vector graphics and text elements intended to comprise a single vector graphic.

Parameters

propname The new automation properties name.

◆ setEdgeMode()

virtual void IDOMCanvas::setEdgeMode ( eEdgeMode em )

pure virtual

Sets render the options edge mode of the <Canvas> element.

The EdgeMode property controls how the edges of paths within the canvas are rendered. The only valid value is Aliased. Omitting this attribute causes the edges to be rendered in the consumers default manner. The EdgeMode property can be set in a Canvas to instruct anti-aliasing consumers to render the contents of the Canvas and all child and descendant nodes without performing antialiasing.

Parameters

em	The new edge mode for the canvas.

◆ setLanguage()

virtual void IDOMCanvas::setLanguage ( const EDLString & lang )

pure virtual

Sets the default language of the <Canvas> element and any of its children.

Parameters

lang	The new language setting for the canvas.

English is defined as en_GB and American English as en_US. There is no default setting. If the language is not known it is set to und (undetermined). For further information see http://www.w3.org/International/articles/language-tags/.

The language is specified according to RFC 3066.

◆ setNavigateLink()

virtual void IDOMCanvas::setNavigateLink ( const IDOMTargetPtr & target )

pure virtual

Sets the target of a hyperlink.

Parameters

target The new target for the hyperlink.

◆ setResourceDictionary()

virtual void IDOMCanvas::setResourceDictionary ( const IDOMResourceDictionaryPtr & ptrResourceDictionary )

pure virtual

Sets the resource dictionary.

The resource dictionary contains the IDs of resources stored at this level of the document.

Parameters

ptrResourceDictionary Smart pointer to the resource dictionary

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

idomcanvas.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ getAutomationPropertiesHelpText()

◆ getAutomationPropertiesName()

◆ getEdgeMode()

◆ getLanguage()

◆ getNavigateLink()

◆ getResourceDictionary()

◆ setAutomationPropertiesHelpText()

◆ setAutomationPropertiesName()

◆ setEdgeMode()

◆ setLanguage()

◆ setNavigateLink()

◆ setResourceDictionary()