Represents <FixedPage> element. More...

#include <idompage.h>

Inheritance diagram for IDOMFixedPage:

[legend]

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual void	setWidth (double width)=0
	Sets the fixed page width. More...

virtual double	getWidth () const =0
	Retrieves the fixed page width. More...

virtual void	setHeight (double height)=0
	Sets the fixed page height. More...

virtual double	getHeight () const =0
	Retrieves the fixed page height. More...

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. More...

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. More...

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. More...

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. More...

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. More...

virtual void	setCropBox (const FRect &cropBox)=0
	Sets the fixed page's crop box. More...

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. More...

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. More...

virtual EDLString	getLanguage () const =0
	Retrieves default language of the fixed page and any of its children. More...

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. More...

virtual void	setPageGroup (const IDOMTransparencyGroupPtr &pageGroup)=0
	Set the page transparency group. More...

virtual void	setLanguage (const EDLString &lang)=0
	Sets the language of the fixed page and any of its children. More...

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. More...

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

virtual IDOMImagePtr	getThumbnail () const =0
	Retrieves a smart pointer to the fixed document thumbnail image. More...

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. More...

Public Member Functions inherited from IDOMJobTkOwner
virtual IDOMJobTkPtr	getJobTicket () const =0
	Retrieves the JobTicket held by this node. More...

virtual void	setJobTicket (const IDOMJobTkPtr &ptrJobTicket)=0
	Sets the JobTicket for the node. 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 EDL_API IDOMFixedPagePtr	create (IEDLClassFactory *pFactory, double width=793.7, double height=1122.5)
	Simplified creation function for IDOMFixedPage Throws an IEDLError exception on failure. More...

static const CClassID &	classID ()
	Retrieves the class id of IDOMFixedPage. More...

Static Public Member Functions inherited from IDOMJobTkOwner
static const CClassID &	classID ()
	Retrieves the class id of IDOMJobTkOwner. 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

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.

Member Function Documentation

◆ classID()

static const CClassID& IDOMFixedPage::classID ( )

inlinestatic

Retrieves the class id of IDOMFixedPage.

Returns: CClassID Class id of the IDOMFixedPage

◆ create()

static EDL_API IDOMFixedPagePtr IDOMFixedPage::create	(	IEDLClassFactory *	pFactory,
		double	width = `793.7`,
		double	height = `1122.5`
	)

static

Simplified creation function for IDOMFixedPage Throws an IEDLError exception on failure.

Parameters

pFactory	The EDL class factory
width	Description for width (defaults to 210mm, width of A4)
height	Description for height (defaults to 297mm, height of A4)

Returns: IDOMFixedPagePtr A smart pointer to the fixed page

◆ getBleedBox()

virtual const FRect& IDOMFixedPage::getBleedBox ( ) const

pure virtual

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.

These values are specified in units of 1/96 inch.

Returns: FRect The fixed page's bleed box.

◆ getContentBox()

virtual const FRect& IDOMFixedPage::getContentBox ( ) const

pure virtual

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.

These values are specified in units of 1/96 inch.

Returns: FRect The fixed page's content box

◆ getCropBox()

virtual const FRect& IDOMFixedPage::getCropBox ( ) const

pure virtual

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.

Returns: FRect The fixed page's crop box.

◆ getHeight()

virtual double IDOMFixedPage::getHeight ( ) const

pure virtual

Retrieves the fixed page height.

Returns: double Returns the fixed page height

◆ getLanguage()

virtual EDLString IDOMFixedPage::getLanguage ( ) const

pure virtual

Retrieves default language of the fixed page and any of its children.

The language is specified according to RFC 3066. 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/

Returns: EDLString The language of the fixed page.

◆ getPageGroup()

virtual IDOMTransparencyGroupPtr IDOMFixedPage::getPageGroup ( ) const

pure virtual

Retrieves the page transparency group, if present. Generally this is used to dictate the color space in which transparency blending will be performed.

Returns: IDOMTransparencyGroupPtr Smart pointer to the page group, or NULL if no page group is supplied.

◆ getResourceDictionary()

virtual IDOMResourceDictionaryPtr IDOMFixedPage::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: IDOMResourceDictionaryPtr The resource dictionary or NULL of no resource dictionary is present.

◆ getThumbnail()

virtual IDOMImagePtr IDOMFixedPage::getThumbnail ( ) const

pure virtual

Retrieves a smart pointer to the fixed document thumbnail image.

Returns: IDOMImagePtr The thumbnail image or NULL if no thumbmail is present.

◆ getTrimBox()

virtual const FRect& IDOMFixedPage::getTrimBox ( ) const

pure virtual

Retrieves the fixed page's trim box. The trim box defines the intended dimensions of the finished page after trimming.

These values are specified in units of 1/96 inch.

Returns: FRect The fixed page's trim box.

◆ getWidth()

virtual double IDOMFixedPage::getWidth ( ) const

pure virtual

Retrieves the fixed page width.

Returns: double Returns the fixed page width.

◆ setBleedBox()

virtual void IDOMFixedPage::setBleedBox ( const FRect & bb )

pure virtual

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.

These values are specified in units of 1/96 inch.

Parameters

bb	The new bleed box settings.

◆ setContentBox()

virtual void IDOMFixedPage::setContentBox ( const FRect & bb )

pure virtual

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.

These values are specified in units of 1/96 inch.

Parameters

bb	The new content box settings

◆ setCropBox()

virtual void IDOMFixedPage::setCropBox ( const FRect & cropBox )

pure virtual

Sets the fixed page's crop box.

Parameters

cropBox The new crop box settings.

◆ setHeight()

virtual void IDOMFixedPage::setHeight ( double height )

pure virtual

Sets the fixed page height.

The height of the page is expressed as a real number in units of 1/96th of an inch. If either the width or height of the page (or both) is set to greater than the original page width or height, a larger page will result. This would have more white space toward the right and/or bottom of the page when the document is viewed in an XPS viewer, since the document origin is in the top-left corner. Changing the page dimensions has no effect on the coordinates of the page content.

Parameters

height New fixed page height.

◆ setLanguage()

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

pure virtual

Sets the language of the fixed page and any of its children.

The language is specified according to RFC 3066. English is defined as en_GB and American English as en_US. There is no default setting. For further information see http://www.w3.org/International/articles/language-tags/

Parameters

lang	The new language setting.

◆ setPageGroup()

virtual void IDOMFixedPage::setPageGroup ( const IDOMTransparencyGroupPtr & pageGroup )

pure virtual

Set the page transparency group.

Parameters

pageGroup A reference to the desired transparency group, or NULL.

◆ setResourceDictionary()

virtual void IDOMFixedPage::setResourceDictionary ( const IDOMResourceDictionaryPtr & ptrResources )

pure virtual

Sets the resource dictionary.

Parameters

ptrResources Smart pointer to the new resource dictionary The resource dictionary contains the IDs of resources stored at this level of the document.

◆ setThumbnail()

virtual void IDOMFixedPage::setThumbnail ( const IDOMImagePtr & ptrThumbnail )

pure virtual

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.

Parameters

ptrThumbnail Smart pointer to new thumbnail image.

◆ setTrimBox()

virtual void IDOMFixedPage::setTrimBox ( const FRect & trimBox )

pure virtual

Sets the fixed page's trim box. The trim box defines the intended dimensions of the finished page after trimming.

These values are specified in units of 1/96 inch.

Parameters

trimBox The new trim box settings.

◆ setWidth()

virtual void IDOMFixedPage::setWidth ( double width )

pure virtual

Sets the fixed page width.

The width of the page is expressed as a real number in units of 1/96th of an inch. If either the width or height of the page (or both) is set to greater than the original page width or height, a larger page will result. This would have more white space toward the right and/or bottom of the page when the document is viewed in an XPS viewer, since the document origin is in the top-left corner. Changing the page dimensions has no effect on the coordinates of the page content.

Parameters

width New fixed page width

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

idompage.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ create()

◆ getBleedBox()

◆ getContentBox()

◆ getCropBox()

◆ getHeight()

◆ getLanguage()

◆ getPageGroup()

◆ getResourceDictionary()

◆ getThumbnail()

◆ getTrimBox()

◆ getWidth()

◆ setBleedBox()

◆ setContentBox()

◆ setCropBox()

◆ setHeight()

◆ setLanguage()

◆ setPageGroup()

◆ setResourceDictionary()

◆ setThumbnail()

◆ setTrimBox()

◆ setWidth()