JawsMako::ILayoutImageRun Class Reference

A run of image content to be added to an ILayoutParagraph. More...

#include <jawsmako/layout.h>

Inheritance diagram for JawsMako::ILayoutImageRun:

Public Member Functions
virtual	~ILayoutImageRun ()
virtual const IDOMImagePtr &	getImage () const =0
	Get the image.
virtual double	getWidth () const =0
	Get the width of the image.
virtual double	getHeight () const =0
	Get the height of the image.
Public Member Functions inherited from JawsMako::ILayoutRun
virtual	~ILayoutRun ()
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.

Static Public Member Functions
static JAWSMAKO_API ILayoutImageRunPtr	create (const IJawsMakoPtr &jawsMako, const IDOMImagePtr &image, double width=0.0, double height=0.0)
	Create an image run.

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

Detailed Description

A run of image content to be added to an ILayoutParagraph.

Constructor & Destructor Documentation

~ILayoutImageRun()

virtual JawsMako::ILayoutImageRun::~ILayoutImageRun ( )

inlinevirtual

Member Function Documentation

create()

JAWSMAKO_API ILayoutImageRunPtr JawsMako::ILayoutImageRun::create ( const IJawsMakoPtr & jawsMako, const IDOMImagePtr & image, double width = 0.0, double height = 0.0 )

static

Create an image run.

Parameters

jawsMako	The IJawsMako object.
image	The desired image for the run.
width	The desired image width. The default value of 0 will scale the image uniformly with the height. When both width and height are set to 0 the image width and height will be used.
height	The desired image height. The default value of 0 will scale the image uniformly with the width. When both width and height are set to 0 the image width and height will be used.

Returns

ILayoutImageRunPtr The new run.

getHeight()

virtual double JawsMako::ILayoutImageRun::getHeight ( ) const

pure virtual

Get the height of the image.

Returns

double The height of the image.

getImage()

virtual const IDOMImagePtr & JawsMako::ILayoutImageRun::getImage ( ) const

pure virtual

Get the image.

Returns

IDOMImagePtr The image.

getWidth()

virtual double JawsMako::ILayoutImageRun::getWidth ( ) const

pure virtual

Get the width of the image.

Returns

double The width of the image.

---

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

• jawsmako/layout.h