A canvas is a special form of an isolated, non-knockout, normal blended transparency group.
More...
|
virtual EDLString | getLanguage () const =0 |
| Retrieves the default language of the <Canvas> element and any of its children.
|
|
virtual void | setLanguage (const EDLString &lang)=0 |
| Sets the default language of the <Canvas> element and any of its children.
|
|
virtual EDLString | getAutomationPropertiesName () const =0 |
| Retrieves the automation properties name of the <Canvas> element.
|
|
virtual void | setAutomationPropertiesName (const EDLString &propname)=0 |
| Sets the automation properties name of the <Canvas> element.
|
|
virtual EDLString | getAutomationPropertiesHelpText () const =0 |
| Retrieves the automation properties help text of the <Canvas> element.
|
|
virtual void | setAutomationPropertiesHelpText (const EDLString &helptext)=0 |
| Sets automation properties help text of the <Canvas> element.
|
|
virtual eEdgeMode | getEdgeMode () const =0 |
| Retrieves render options edge mode of the <Canvas> element.
|
|
virtual void | setEdgeMode (eEdgeMode em)=0 |
| Sets render the options edge mode of the <Canvas> element.
|
|
virtual IDOMTargetPtr | getNavigateLink () const =0 |
| Retrieves the target of a hyperlink.
|
|
virtual void | setNavigateLink (const IDOMTargetPtr &target)=0 |
| Sets the target of a hyperlink.
|
|
virtual IDOMResourceDictionaryPtr | getResourceDictionary () const =0 |
| Retrieves a smart pointer to the resource dictionary.
|
|
virtual void | setResourceDictionary (const IDOMResourceDictionaryPtr &ptrResourceDictionary)=0 |
| Sets the resource dictionary.
|
|
virtual float | getOpacity () const =0 |
| Get the group alpha/opacity.
|
|
virtual void | setOpacity (float opacity)=0 |
| Set the group opacity.
|
|
virtual eBlendMode | getBlendMode () const =0 |
| Get the blend mode to be used for compositing this group with the backdrop.
|
|
virtual void | setBlendMode (eBlendMode blendMode)=0 |
| Set the blend mode to be used for compositing this group with the backdrop.
|
|
virtual IDOMColorSpacePtr | getColorSpace () const =0 |
| Get the group colorspace.
|
|
virtual void | setColorSpace (const IDOMColorSpacePtr &colorSpace)=0 |
| Set the group colorspace.
|
|
virtual bool | getIsIsolated () const =0 |
| Is the group an isolated group? See section 7.5.5 of the PDF 1.7 spec for details.
|
|
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.
|
|
virtual bool | getIsKnockout () const =0 |
| Is the group a knockout group? See section 7.5.5 of the PDF 1.7 spec for details.
|
|
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.
|
|
virtual IDOMBrushPtr | getOpacityMask () const =0 |
| Retrieves smart pointer to opacity mask.
|
|
virtual void | setOpacityMask (const IDOMBrushPtr &ptrOpacityMask)=0 |
| Sets opacity mask.
|
|
virtual eRenderingIntent | getRenderingIntent () const =0 |
| Get the rendering intent for the node if present. The rendering intent is used whenever the node requires color conversion to a different color space. Set eRenderingIntentUnset to unset the rendering intent, in which a default will be chosen based on the color space in use. This setting is honored only for rendering, color conversion, PDF or PostScript output.
|
|
virtual void | setRenderingIntent (eRenderingIntent intent)=0 |
| Set or clear the rendering intent for the node. The rendering intent is used whenever the node requires color conversion to a different color space. Set eRenderingIntentUnset to unset the rendering intent, in which a default will be chosen based on the color space in use. This setting is honored only for rendering, color conversion, PDF or PostScript output.
|
|
virtual eBlackPointCompensation | getBlackPointCompensation () const =0 |
| Get the black point compensation for the node. The black point compensation setting is used whenever the node requires color conversion to a different color space and affects how dark regions are handled. This setting is honored only for rendering, color conversion, PDF or PostScript output.
|
|
virtual void | setBlackPointCompensation (eBlackPointCompensation compensation)=0 |
| Set the black point compensation for the node. The black point compensation setting is used whenever the node requires color conversion to a different color space and affects how dark regions are handled. This setting is honored only for rendering, color conversion, PDF or PostScript output.
|
|
virtual const FMatrix & | getRenderTransform () const =0 |
| Retrieves render transform matrix of the Group and its children.
|
|
virtual void | setRenderTransform (const FMatrix &matrix)=0 |
| Sets render transform matrix of the Group and its children.
|
|
virtual IDOMPathGeometryPtr | getClip () const =0 |
| Retrieves smart pointer to the clip.
|
|
virtual void | setClip (const IDOMPathGeometryPtr &ptrClip)=0 |
| Sets clip.
|
|
virtual JawsMako::IOptionalContentDetailsPtr | getOptionalContentDetails () const =0 |
| Get the JawsMako Optional Content details, or NULL if the group is not subject to optional content.
|
|
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.
|
|
virtual JawsMako::IMarkedContentDetailsPtr | getMarkedContentDetails () const =0 |
| Get the JawsMako Marked Content details for this group, or NULL if the group is not marked.
|
|
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.
|
|
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.
|
|
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.
|
|
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.
|
|
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.