IlvPrintableComposite Class Reference

This class lets you merge several IlvPrintable objects in the same IlvPrintable. More...

#include <ilviews/printing/composite.h>

Inheritance diagram for IlvPrintableComposite:

Classes
class	Coordinates
	This class represents the concept of coordinates of a component of a composite. More...
class	DeducedPositionCoordinate
	This class is used to represent the concept of a deduced end point of a segment, that is computed by the calling object. More...
class	DeducedSegmentCoordinates
	This class is used to represent the deduced position, on an axis, of a component that are computed by the calling object. More...
class	DeltaRelativePositionCoordinate
	This class is used to represent the concept of the end point of a segment relatively in pixel to the bounding box of an IlvPrintableComposite. More...
class	DeltaRelativeSegmentCoordinates
	This class is used to represent the position in pixel, on an axis, of a component relatively to the bounding box of an IlvPrintableComposite. More...
class	Iterator
	Iterator class to walk through the objects stored in an IlvPrintableComposite. More...
class	PositionCoordinate
	This is an abstract class representing the concept of the end point of a segment. More...
class	RatioRelativePositionCoordinate
	This class is used to represent the concept of the end point of a segment with a percentage of the bounding box of an IlvPrintableComposite. The ratio is actually stored in hundredths of a percent. More...
class	RatioRelativeSegmentCoordinates
	This class is used to represent the position, on an axis, of a component. It is a percentage of the bounding box of an IlvPrintableComposite. It is stored in hundredths of a percent. More...
class	RelativePositionCoordinate
	This abstract class is used to represent the concept of the end point of a segment relatively to the bounding box of an IlvPrintableComposite. More...
class	RelativeSegmentCoordinates
	This is an abstract class that represents the concept of relative position, on an axis, of a component. More...
class	SegmentCoordinates
	This is an abstract class that represents the concept of the position, on an axis, of a component. More...

Public Member Functions
	IlvPrintableComposite ()
	The default constructor.
virtual	~IlvPrintableComposite ()
	The destructor.
Iterator	append (IlvPrintable *printable, Coordinates const &coordinates)
	Appends a new IlvPrintable. More...
Iterator	begin () const
	Returns an iterator to the first IlvPrintable. More...
Iterator	end () const
	Returns an iterator to one past the last IlvPrintable. More...
virtual IlvRect	getBBox (IlvPrintableJob const &job) const
	Gets the bounding box of the area to print. More...
Iterator	insert (IlvPrintable *printable, Coordinates const &coordinates, Iterator const &iterator)
	Inserts a new IlvPrintable. 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...

Protected Member Functions
virtual IlBoolean	internalPrint (IlvPrintableJob const &job) const
	This function actually prints the composite. More...

Detailed Description

This class lets you merge several IlvPrintable objects in the same IlvPrintable.

Library: ilvprint

IlvPrintableComposite contains a list of IlvPrintable instances together with information on how to place them relatively.

See also

IlvPrintableDocument::append

Member Function Documentation

Iterator IlvPrintableComposite::append	(	IlvPrintable *	printable,
		Coordinates const &	coordinates
	)

Appends a new IlvPrintable.

Parameters

printable	The IlvPrintable to add.
coordinates	The Coordinates to add.

Iterator IlvPrintableComposite::begin

(

)

const

Returns an iterator to the first IlvPrintable.

Returns

An iterator to the first IlvPrintable.

Iterator IlvPrintableComposite::end

(

)

const

Returns an iterator to one past the last IlvPrintable.

Returns

An iterator to one past the last IlvPrintable.

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

virtual

Gets the bounding box of the area to print.

Parameters

job	The settings of the current printing job.

Returns

The bounding box.

Implements IlvPrintable.

Iterator IlvPrintableComposite::insert	(	IlvPrintable *	printable,
		Coordinates const &	coordinates,
		Iterator const &	iterator
	)

Inserts a new IlvPrintable.

Parameters

printable	The IlvPrintable to add.
coordinates	The Coordinates to add.
iterator	A reference to an iterator to the location where the insertion must take place.

virtual IlBoolean IlvPrintableComposite::internalPrint ( IlvPrintableJob const &  job ) const

protectedvirtual

This function actually prints the composite.

Parameters

job	The settings of the current printing job.

Returns

IlFalse if an error occurred during the printing, IlTrue otherwise.

Implements IlvPrintable.