Provides an interface to a DOM image brush object. More...

#include <idombrush.h>

Inheritance diagram for IDOMImageBrush:

[legend]

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual eTilingMode	getTileMode () const =0
	Retrieves the tiling mode value of the image brush. More...

virtual void	setTileMode (eTilingMode tm)=0
	Sets the tiling mode of the image brush. More...

virtual eViewUnits	getViewBoxUnits () const =0
	Retrieves the viewbox units used by the image brush. Currently, only absolute units are supported. More...

virtual void	setViewBoxUnits (eViewUnits vu)=0
	Sets the viewbox units value of the image brush. Currently, only absolute units are supported. More...

virtual eViewUnits	getViewPortUnits () const =0
	Retrieves the viewport units value of the image brush. Currently, only absolute units are supported. More...

virtual void	setViewPortUnits (eViewUnits vu)=0
	Sets the viewport units used for the image brush. Currently, only absolute units are supported. More...

virtual const FRect &	getViewBox () const =0
	Retrieves the viewbox rectangle. More...

virtual void	setViewBox (const FRect &vb)=0
	Sets the viewbox rectangle. More...

virtual const FRect &	getViewPort () const =0
	Retrieves the viewport rectangle. More...

virtual void	setViewPort (const FRect &vp)=0
	Sets the viewport rectangle. More...

virtual IDOMICCProfilePtr	getICCProfile () const =0
	Retrieves the external ICC profile of the brush if present. More...

virtual void	setICCProfile (const IDOMICCProfilePtr &icc)=0
	Retrieves the external ICC profile of the brush if present. More...

virtual IDOMImagePtr	getImageSource () const =0
	Retrieves a smart pointer to the image resource. More...

virtual void	setImageSource (const IDOMImagePtr &ptrImageSource)=0
	Sets the image resource for the brush. More...

virtual CDOMAlternateImageVect	getAlternateImages () const =0
	Retrieves any alternate images associated with this brush. More...

virtual void	setAlternateImages (const CDOMAlternateImageVect &alternates)=0
	Set the alternate images associated with this brush. More...

virtual JawsMako::IOptionalContentDetailsPtr	getOptionalContentDetails () const =0
	Returns any optional content information that applies to this brush. More...

virtual void	setOptionalContentDetails (const JawsMako::IOptionalContentDetailsPtr &details)=0
	Set the optional content details that apply to this brush, or NULL to remove. More...

virtual JawsMako::IPDFDictionaryPtr	getPdfPropertiesDictionary () const =0
	Get the dictionary containing PDF properties attached to the image object. This dictionary will be as per the XObject dictionary in the original PDF, but with entries handled by existing DOM features stripped. In particular, the following entries described in the PDF specification will not be present in the dictionary: More...

virtual void	setPdfPropertiesDictionary (const JawsMako::IPDFDictionaryPtr &propertiesDictionary)=0
	Set the dictionary containing PDF properties attached to the image object. Please see getPdfPropertiesDictionary() above for information on the form of this dictionary. More...

virtual IDOMTilingPatternBrushPtr	getEquivalentTilingBrush (IEDLClassFactory *pFactory)=0
	Gets an equivalent IDOMTilingPattern brush. If the receiver has a tile mode of eNoTile, this call will fail. More...

virtual IDOMVisualBrushPtr	getEquivalentVisualBrush (IEDLClassFactory *pFactory)=0
	For tiled images, returns an equivalent visual brush containing the image without tiling. Will throw an exception if the image is not tiled. Not available for masked brushes as tiling is not supported for those brushes. More...

Public Member Functions inherited from IDOMTransformableBrush
virtual const FMatrix &	getRenderTransform () const =0
	Retrieves the render transform matrix. More...

virtual void	setRenderTransform (const FMatrix &matrix)=0
	Sets the render transform matrix. More...

Public Member Functions inherited from IDOMBrush
virtual eBrushType	getBrushType () const =0
	Retrieves the type of the brush. More...

virtual float	getOpacity () const =0
	Retrieves the opacity value of the brush element. More...

virtual void	setOpacity (float opc)=0
	Sets the opacity value of a brush element. More...

virtual IDOMBrushPtr	getAdjustedForUseInTransformedNode (IEDLClassFactory *pFactory, const FMatrix &nodeTransform)
	Get a version of this brush adjusted for use inside a node with the given transform. 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...

Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.

virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object. More...

virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails. More...

Static Public Member Functions
static EDL_API IDOMImageBrushPtr	create (IEDLClassFactory *pFactory, const IDOMImagePtr &image, const FRect &viewBox, const FRect &viewPort, const FMatrix &renderTransform=FMatrix(), float opacity=1.0f, eTilingMode tileMode=eNoTile, const CDOMAlternateImageVect &alternateImages=CDOMAlternateImageVect(), const JawsMako::IOptionalContentDetailsPtr &optionalContentDetails=JawsMako::IOptionalContentDetailsPtr(), const JawsMako::IPDFDictionaryPtr &propertiesDictionary=JawsMako::IPDFDictionaryPtr())
	Simplified creator for an image brush. Throws an IEDLError on failure. More...

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

Additional Inherited Members
Public Types inherited from IDOMBrush
enum	eBrushType { eSolidColor , eLinearGradient , eRadialGradient , eImage , eMasked , eVisual , eSoftMask , eTilingPattern , eType1ShadingPattern , eType2ShadingPattern , eType3ShadingPattern , eType4567ShadingPattern , eNull }
	Brush type enumeration. More...

Protected Member Functions inherited from IRCObject
virtual	~IRCObject ()
	Virtual destructor.

Detailed Description

Provides an interface to a DOM image brush object.

An image brush is used to fill a region with an image. The image is defined in a coordinate space specified by the resolution of the image.

Member Function Documentation

◆ classID()

static const CClassID& IDOMImageBrush::classID ( )

inlinestatic

Retrieves class id of IDOM.

Returns: CClassID Class id of the element

◆ create()

static EDL_API IDOMImageBrushPtr IDOMImageBrush::create	(	IEDLClassFactory *	pFactory,
		const IDOMImagePtr &	image,
		const FRect &	viewBox,
		const FRect &	viewPort,
		const FMatrix &	renderTransform = `FMatrix()`,
		float	opacity = `1.0f`,
		eTilingMode	tileMode = `eNoTile`,
		const CDOMAlternateImageVect &	alternateImages = `CDOMAlternateImageVect()`,
		const JawsMako::IOptionalContentDetailsPtr &	optionalContentDetails = `JawsMako::IOptionalContentDetailsPtr()`,
		const JawsMako::IPDFDictionaryPtr &	propertiesDictionary = `JawsMako::IPDFDictionaryPtr()`
	)

static

Simplified creator for an image brush. Throws an IEDLError on failure.

Parameters

pFactory	The factory to use.
image	The image to use.
viewBox	The desired view box. If empty, the viewPort will be set to the full area of the image.
viewPort	The desired view port.
renderTransform	The desired render transform.
opacity	The desired brush opacity.
tileMode	The desired tile mode.
alternateImages	The PDF Alternate image brushes, if present.
optionalContentDetails	The optional content details. Ignored for tiling images
propertiesDictionary	Dictionary containing any additional PDF properties

Returns: IDOMImageBrushPtr The new brush.

◆ getAlternateImages()

virtual CDOMAlternateImageVect IDOMImageBrush::getAlternateImages ( ) const

pure virtual

Retrieves any alternate images associated with this brush.

Returns: CDOMAlternateImageVect The alternate images, or an empty vector if there are no alternates.

◆ getEquivalentTilingBrush()

virtual IDOMTilingPatternBrushPtr IDOMImageBrush::getEquivalentTilingBrush ( IEDLClassFactory * pFactory )

pure virtual

Gets an equivalent IDOMTilingPattern brush. If the receiver has a tile mode of eNoTile, this call will fail.

Parameters

pFactory A pointer to an EDL class factory

Returns: IDOMTilingPatternBrushPtr The resulting tiling brush. This brush will be cached, so do not edit; make a clone if the returned brush needs to be changed.

◆ getEquivalentVisualBrush()

virtual IDOMVisualBrushPtr IDOMImageBrush::getEquivalentVisualBrush ( IEDLClassFactory * pFactory )

pure virtual

For tiled images, returns an equivalent visual brush containing the image without tiling. Will throw an exception if the image is not tiled. Not available for masked brushes as tiling is not supported for those brushes.

Parameters

pFactory A pointer to an EDL class factory

Returns: IDOMVisualBrushPtr The created visual brush. This brush will be cached, so do not edit; make a clone if the returned brush needs to be changed.

◆ getICCProfile()

virtual IDOMICCProfilePtr IDOMImageBrush::getICCProfile ( ) const

pure virtual

Retrieves the external ICC profile of the brush if present.

Returns: IDOMICCProfilePtr The profile of the image, or NULL if no profile provided.

◆ getImageSource()

virtual IDOMImagePtr IDOMImageBrush::getImageSource ( ) const

pure virtual

Retrieves a smart pointer to the image resource.

Returns: IDOMImagePtr the image resource

◆ getOptionalContentDetails()

virtual JawsMako::IOptionalContentDetailsPtr IDOMImageBrush::getOptionalContentDetails ( ) const

pure virtual

Returns any optional content information that applies to this brush.

Returns: IOptionalContentDetailsPtr The optional content details, or NULL if optional content details do not apply

◆ getPdfPropertiesDictionary()

virtual JawsMako::IPDFDictionaryPtr IDOMImageBrush::getPdfPropertiesDictionary ( ) const

pure virtual

Get the dictionary containing PDF properties attached to the image object. This dictionary will be as per the XObject dictionary in the original PDF, but with entries handled by existing DOM features stripped. In particular, the following entries described in the PDF specification will not be present in the dictionary:

Type
Subtype
Width
Height
ColorSpace
BitsPerComponent
Intent
ImageMask
Mask
Decode
Interpolate
Alternates
SMask
SMaskInData
Name
OC
Returns
IPDFDictionaryPtr The properties dictionary, or NULL if not present. If non-null, the dictionary may be edited freely.

◆ getTileMode()

virtual eTilingMode IDOMImageBrush::getTileMode ( ) const

pure virtual

Retrieves the tiling mode value of the image brush.

See also: eTilingMode

Returns: eTilingMode The image tiling mode.

◆ getViewBox()

virtual const FRect& IDOMImageBrush::getViewBox ( ) const

pure virtual

Retrieves the viewbox rectangle.

The viewbox specifies the portion of a source image or visual to be rendered to the page as a tile, whose size and location are determined by the image brush's viewport. The tile is then used to fill the geometry specified by the parent element according to the image brush's tile mode. The ViewBox can specify a region larger than the image itself, including negative values. The view box specifies the position and dimension of the brush's source content. It is specified by four comma-separated real numbers (x, y, width, height) where width and height are non-negative.

Returns: FRect the viewbox rectangle

◆ getViewBoxUnits()

virtual eViewUnits IDOMImageBrush::getViewBoxUnits ( ) const

pure virtual

Retrieves the viewbox units used by the image brush. Currently, only absolute units are supported.

See also: getViewBox(); setViewBox()

Returns: eViewUnits The viewbox units.

◆ getViewPort()

virtual const FRect& IDOMImageBrush::getViewPort ( ) const

pure virtual

Retrieves the viewport rectangle.

The viewport specifies the dimensions and location of the initial tile that will be filled with the specified image or visual fragment. It is defined in the current effective coordinate space. It is specified by four comma separated real numbers (x, y, width, height) where width and height are non-negative.

Returns: FRect the viewport rectangle

◆ getViewPortUnits()

virtual eViewUnits IDOMImageBrush::getViewPortUnits ( ) const

pure virtual

Retrieves the viewport units value of the image brush. Currently, only absolute units are supported.

See also: getViewPort(); setViewPort()

Returns: eViewUnits The viewport units.

◆ setAlternateImages()

virtual void IDOMImageBrush::setAlternateImages ( const CDOMAlternateImageVect & alternates )

pure virtual

Set the alternate images associated with this brush.

Parameters

alternates The alternate images.

◆ setICCProfile()

virtual void IDOMImageBrush::setICCProfile ( const IDOMICCProfilePtr & icc )

pure virtual

Retrieves the external ICC profile of the brush if present.

Parameters

icc	The profile of the image, or NULL to clear

◆ setImageSource()

virtual void IDOMImageBrush::setImageSource ( const IDOMImagePtr & ptrImageSource )

pure virtual

Sets the image resource for the brush.

Parameters

ptrImageSource Smart pointer to the new image resource.

◆ setOptionalContentDetails()

virtual void IDOMImageBrush::setOptionalContentDetails ( const JawsMako::IOptionalContentDetailsPtr & details )

pure virtual

Set the optional content details that apply to this brush, or NULL to remove.

Parameters

◆ setPdfPropertiesDictionary()

virtual void IDOMImageBrush::setPdfPropertiesDictionary ( const JawsMako::IPDFDictionaryPtr & propertiesDictionary )

pure virtual

Set the dictionary containing PDF properties attached to the image object. Please see getPdfPropertiesDictionary() above for information on the form of this dictionary.

Parameters

propertiesDictionary The properties dictionary to set, or NULL to clear.

◆ setTileMode()

virtual void IDOMImageBrush::setTileMode ( eTilingMode tm )

pure virtual

Sets the tiling mode of the image brush.

Parameters

tm	The tiling mode value

◆ setViewBox()

virtual void IDOMImageBrush::setViewBox ( const FRect & vb )

pure virtual

Sets the viewbox rectangle.

The viewbox specifies the portion of a source image or visual to be rendered to the page as a tile. The tile is then used to fill the geometry specified by the parent element according to the TileMode() function. The viewbox can specify a region larger than the image itself, including negative values. The viewbox specifies the position and dimension of the brush's source content. It is specified by four comma-separated real numbers (x, y, width, height) where width and height are non-negative.

Parameters

vb	The viewbox rectangle

◆ setViewBoxUnits()

virtual void IDOMImageBrush::setViewBoxUnits ( eViewUnits vu )

pure virtual

Sets the viewbox units value of the image brush. Currently, only absolute units are supported.

See also: getViewBox(); setViewBox()

Parameters

vu	The viewbox units value

◆ setViewPort()

virtual void IDOMImageBrush::setViewPort ( const FRect & vp )

pure virtual

Sets the viewport rectangle.

The viewport specifies the dimensions and location of the initial tile that will be filled with the specified image or visual fragment. It is defined in the current effective coordinate space. It is specified by four comma separated real numbers (x, y, width, height) where width and height are non-negative.

Parameters

vp	The viewport rectangle

◆ setViewPortUnits()

virtual void IDOMImageBrush::setViewPortUnits ( eViewUnits vu )

pure virtual

Sets the viewport units used for the image brush. Currently, only absolute units are supported.

See also: getViewPort(); setViewPort()

Parameters

vu	The new viewport units value

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

idombrush.h

Classes

Public Member Functions

Static Public Member Functions

Additional Inherited Members

Detailed Description

Member Function Documentation

◆ classID()

◆ create()

◆ getAlternateImages()

◆ getEquivalentTilingBrush()

◆ getEquivalentVisualBrush()

◆ getICCProfile()

◆ getImageSource()

◆ getOptionalContentDetails()

◆ getPdfPropertiesDictionary()

◆ getTileMode()

◆ getViewBox()

◆ getViewBoxUnits()

◆ getViewPort()

◆ getViewPortUnits()

◆ setAlternateImages()

◆ setICCProfile()

◆ setImageSource()

◆ setOptionalContentDetails()

◆ setPdfPropertiesDictionary()

◆ setTileMode()

◆ setViewBox()

◆ setViewBoxUnits()

◆ setViewPort()

◆ setViewPortUnits()