IDOMPDFAlternateImage Class Reference

An encapsulation of a PDF alternate image, which may be referenced from an image or mask brush. More...

#include <idomimageresource.h>

Inheritance diagram for IDOMPDFAlternateImage:

Classes
class	Data
	Initialization data. More...

Public Member Functions
virtual IDOMImageBrushPtr	getImageBrush () const =0
	Get the image brush for this alternate image.
virtual bool	getDefaultForPrinting () const =0
	Get if the alternate image is marked as default for printing.
virtual JawsMako::IOptionalContentDetailsPtr	getOptionalContentDetails () const =0
	Get the optional content properties, if present.
Public Member Functions inherited from IEDLObject
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.
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.
virtual int32	getRefCount () const =0
	Retrieve the current reference count of the actual object pointed to.
Public Member Functions inherited from IDOMHashable
virtual	~IDOMHashable ()
	Virtual destructor.
virtual bool	hash (uint64 &hash)=0
	Retrieve a hash for this object.
virtual uint64	hashE ()
	As hash(), but throws an exception if the operation fails.

Static Public Member Functions
static EDL_API IDOMPDFAlternateImagePtr	create (IEDLClassFactory *pFactory, const IDOMImageBrushPtr &alternateBrush, bool defaultForPrinting=false, const JawsMako::IOptionalContentDetailsPtr &optionalContentDetails=JawsMako::IOptionalContentDetailsPtr())
	Creator for an alternate image. Although regular, soft mask and masked images are allowed, there are several restrictions on the brushes that can be used for alternate images in order to ensure correct operation.
static const CClassID &	classID ()
	Retrieves class id of IDOMPDFAlternateImage.

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

Detailed Description

An encapsulation of a PDF alternate image, which may be referenced from an image or mask brush.

Member Function Documentation

classID()

static const CClassID & IDOMPDFAlternateImage::classID ( )

inlinestatic

Retrieves class id of IDOMPDFAlternateImage.

Returns

CClassID Class id of the element

create()

static EDL_API IDOMPDFAlternateImagePtr IDOMPDFAlternateImage::create ( IEDLClassFactory * pFactory, const IDOMImageBrushPtr & alternateBrush, bool defaultForPrinting = false, const JawsMako::IOptionalContentDetailsPtr & optionalContentDetails = JawsMako::IOptionalContentDetailsPtr() )

static

Creator for an alternate image.
Although regular, soft mask and masked images are allowed, there are several restrictions on the brushes that can be used for alternate images in order to ensure correct operation.

• The render transform of the alternate brush must be identity.
• The viewport of the alternate brush must match the viewport of the host brush. Note - these two restrictions are in place as the alternate image must be the same final dimensions as the host brush.
• The viewbox of the alternate brush must select the entire image.
• If the alternate brush is a masked brush using an image sub brush, the sub brush is subject to all the restrictions above.
• Alternate images are ignored if the host image brush has tiling enabled
• Optional content and alternate image information must not be present in the alternate brush.

  Parameters

  pFactory	The class factory to use
  alternateBrush	The alternate image brush itself. It must not have any alternate images of its own
  defaultForPrinting	Set true if this image should be the default image when printing
  optionalContentDetails	The optional content details to use, or NULL if not optional

  Returns

  IDOMPDFAlternateImagePtr The new alternate image

getDefaultForPrinting()

virtual bool IDOMPDFAlternateImage::getDefaultForPrinting ( ) const

pure virtual

Get if the alternate image is marked as default for printing.

Returns

bool True if the image is default for printing, false otherwise

getImageBrush()

virtual IDOMImageBrushPtr IDOMPDFAlternateImage::getImageBrush ( ) const

pure virtual

Get the image brush for this alternate image.

Returns

IDOMImageBrushPtr The image, or NULL on failure

getOptionalContentDetails()

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

pure virtual

Get the optional content properties, if present.

Returns

JawsMako::IOptionalContentDetailsPtr The optional content defails, or NULL if not optional

---

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

• idomimageresource.h