|
virtual void | setWidth (double width)=0 |
| Sets the fixed page width.
|
|
virtual double | getWidth () const =0 |
| Retrieves the fixed page width.
|
|
virtual void | setHeight (double height)=0 |
| Sets the fixed page height.
|
|
virtual double | getHeight () const =0 |
| Retrieves the fixed page height.
|
|
virtual const FRect & | getContentBox () const =0 |
| Retrieves the fixed page's content box. The content bos is the area of the page containing imageable content that is to fit within the imageable area when printing or viewing.
|
|
virtual void | setContentBox (const FRect &bb)=0 |
| Sets the content box for the fixed page. The content bos is the area of the page containing imageable content that is to fit within the imageable area when printing or viewing. If omitted, the default value is a content box with an origin of (0,0) (that is, the top left hand corner of the page), with a width set to the width of the page and a height the same as that of the page.
|
|
virtual const FRect & | getBleedBox () const =0 |
| Retrieves the fixed page's bleed box. The bleed box is the area, inclusive of crop marks, that extends outside of the physical page. See Figure 8.11.
|
|
virtual void | setBleedBox (const FRect &bb)=0 |
| Sets the fixed page's bleed box. The bleed box is the area, inclusive of crop marks, that extends outside of the physical page. See Figure 8.11.
|
|
virtual const FRect & | getCropBox () const =0 |
| Retrieves the fixed page's crop box - the region to which the contents of the page are to be clipped (cropped) when displayed or printed.
|
|
virtual void | setCropBox (const FRect &cropBox)=0 |
| Sets the fixed page's crop box.
|
|
virtual const FRect & | getTrimBox () const =0 |
| Retrieves the fixed page's trim box. The trim box defines the intended dimensions of the finished page after trimming.
|
|
virtual void | setTrimBox (const FRect &trimBox)=0 |
| Sets the fixed page's trim box. The trim box defines the intended dimensions of the finished page after trimming.
|
|
virtual EDLString | getLanguage () const =0 |
| Retrieves default language of the fixed page and any of its children.
|
|
virtual IDOMTransparencyGroupPtr | getPageGroup () const =0 |
| Retrieves the page transparency group, if present. Generally this is used to dictate the color space in which transparency blending will be performed.
|
|
virtual void | setPageGroup (const IDOMTransparencyGroupPtr &pageGroup)=0 |
| Set the page transparency group.
|
|
virtual void | setLanguage (const EDLString &lang)=0 |
| Sets the language of the fixed page and any of its children.
|
|
virtual IDOMResourceDictionaryPtr | getResourceDictionary () const =0 |
| Retrieves a smart pointer to the resource dictionary. The resource dictionary contains the IDs of resources stored at this level of the document.
|
|
virtual void | setResourceDictionary (const IDOMResourceDictionaryPtr &ptrResources)=0 |
| Sets the resource dictionary.
|
|
virtual IDOMImagePtr | getThumbnail () const =0 |
| Retrieves a smart pointer to the fixed document thumbnail image.
|
|
virtual void | setThumbnail (const IDOMImagePtr &ptrThumbnail)=0 |
| Sets a new thumbnail image for the document sequence. The image must be in either JPEG or PNG format. Setting thumbnail to NULL deletes the document sequence thumbnail.
|
|
virtual IDOMJobTkPtr | getJobTicket () const =0 |
| Retrieves the JobTicket held by this node.
|
|
virtual void | setJobTicket (const IDOMJobTkPtr &ptrJobTicket)=0 |
| Sets the JobTicket for the node.
|
|
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.
|
|
Represents <FixedPage> element.
A fixed page describes the contents of a page. A fixed page contains all of the visual elements on each page. Each page has a fixed size and orientation. The layout of the visual elements on a page is determined by the fixed page markup. This applies to both graphics and text. The fixed page contains the elements that together form the basis for all markings rendered on the page: that is, Paths, Glyphs and Canvases.
The fixed page specifies a height, width and a default language.