IlvPrintableScalable Class Reference

This class encapsulates an object that may be scaled. More...

#include <ilviews/printing/printable.h>

Inheritance diagram for IlvPrintableScalable:

Public Member Functions
	IlvPrintableScalable (IlvRect const &scalableArea, IlvRegion const *clip=0, IlvTransformer const *t=0)
	The default constructor. More...
virtual IlvRect	getBBox (IlvPrintableJob const &job) const
	Gets the bounding box of the area to print. More...
IlvRegion const &	getClip () const
	Returns the clip size. More...
IlvRect const &	getScalableArea () const
	Returns the area to be printed. More...
IlvTransformer const *	getTransformer () const
	Gets the transformer to be used by the drawing. More...
IlBoolean	hasClip () const
	Returns an indication of whether a clip was given or not. More...
IlBoolean	hasTransformer () const
	Returns an indication of whether a transformer was given or not. More...
void	resetClip ()
	Resets the clip. More...
void	resetTransformer ()
	Resets the transformer. More...
void	setClip (IlvRegion const &clip)
	Sets the clip size. More...
void	setScalableArea (IlvRect const &scalableArea)
	Sets the area to be printed. More...
void	setTransformer (IlvTransformer const *t)
	Sets the transformer to be used by the drawing. More...
Public Member Functions inherited from IlvPrintable
	IlvPrintable ()
	The default constructor.
	IlvPrintable (IlvPrintable const &other)
	The copy constructor. More...
virtual	~IlvPrintable ()
	The destructor. More...
void	lock ()
	Locks the current instance. More...
IlvPrintable &	operator= (IlvPrintable const &other)
	The assignment operator. More...
IlBoolean	print (IlvPrintableJob const &job) const
	Prints the contents of the object. More...
void	unlock ()
	Unlocks the current instance. More...

Additional Inherited Members
Protected Member Functions inherited from IlvPrintable
virtual IlBoolean	internalPrint (IlvPrintableJob const &job) const =0
	This function actually prints the document. More...

Detailed Description

This class encapsulates an object that may be scaled.

Library: ilvprint

This is an abstract class that is intended to be inherited.

See also

IlvPrintableDocument::append

Constructor & Destructor Documentation

IlvPrintableScalable()

IlvPrintableScalable::IlvPrintableScalable	(	IlvRect const &	scalableArea,
		IlvRegion const *	clip = 0,
		IlvTransformer const *	t = 0
	)

The default constructor.

Parameters

scalableArea	The area to be printed.
clip	An optional rectangle used to clip the drawing.
t	An optional transformer used by the drawing.

Member Function Documentation

getBBox()

virtual IlvRect IlvPrintableScalable::getBBox ( IlvPrintableJob const &  job ) const

virtual

Gets the bounding box of the area to print.

Parameters

job	The settings of the current print job.

Returns

The bounding box.

Implements IlvPrintable.

getClip()

IlvRegion const & IlvPrintableScalable::getClip

(

)

const

Returns the clip size.

The size is sensible only if hasClip() returns IlTrue.

Returns

The clip size.

getScalableArea()

IlvRect const & IlvPrintableScalable::getScalableArea

(

)

const

Returns the area to be printed.

Returns

The area to be printed.

getTransformer()

IlvTransformer const * IlvPrintableScalable::getTransformer

(

)

const

Gets the transformer to be used by the drawing.

Returns

A const pointer to an IlvTransformer.

hasClip()

IlBoolean IlvPrintableScalable::hasClip

(

)

const

Returns an indication of whether a clip was given or not.

Returns

IlTrue if a clip was given, IlFalse otherwise.

hasTransformer()

IlBoolean IlvPrintableScalable::hasTransformer

(

)

const

Returns an indication of whether a transformer was given or not.

Returns

IlTrue if a transformer was given, or IlFalse otherwise.

resetClip()

void IlvPrintableScalable::resetClip

(

)

Resets the clip.

The clip is no longer used (hasClip() returns IlFalse).

resetTransformer()

void IlvPrintableScalable::resetTransformer

(

)

Resets the transformer.

The transformer is no longer used (hasTransformer() returns IlFalse).

setClip()

void IlvPrintableScalable::setClip

(

IlvRegion const &

clip

)

Sets the clip size.

The size is sensible only if hasClip() returns IlTrue. The clip is a rectangle.

Parameters

clip	The clip size.

setScalableArea()

void IlvPrintableScalable::setScalableArea

(

IlvRect const &

scalableArea

)

Sets the area to be printed.

Parameters

scalableArea

The area to be printed.

setTransformer()

void IlvPrintableScalable::setTransformer

(

IlvTransformer const *

t

)

Sets the transformer to be used by the drawing.

Parameters

t	A const pointer to an IlvTransformer.