Rogue Wave Views
Foundation Package API Reference Guide
Product Documentation:

Rogue Wave Views
Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvPrintableActualArea Class Reference

This class is used to represent an actual area where to print. More...

#include <ilviews/printing/layout.h>

Inheritance diagram for IlvPrintableActualArea:
IlvPrintableArea

Public Member Functions

 IlvPrintableActualArea (IlvPrintableLayout const &layout, IlvRect const &bbox, IlvTransformer const &transformer)
 The constructor. More...
 
virtual IlvPrintableAreaclone () const
 Returns a pointer to a new instance of IlvPrintableActualArea; this object is a copy of the current object. More...
 
virtual IlBoolean print (IlvPrintableJob &job, IlvPrintable *printable) const
 Prints the area. More...
 
virtual void setBBox (IlvRect const &bbox)
 Sets the size of the area. More...
 
virtual void setTransformer (IlvTransformer const &transformer)
 Sets the transformer of the area. More...
 
- Public Member Functions inherited from IlvPrintableArea
IL_EXPLICIT IlvPrintableArea (IlvPrintableLayout const &layout)
 The constructor. More...
 
virtual ~IlvPrintableArea ()
 The destructor. More...
 
IlvPrintableLayout const & getPrintableLayout () const
 Gets the associated IlvPrintableLayout object. More...
 

Protected Member Functions

IlvRect getBBox () const
 Gets the size of the area. More...
 
IlvTransformer getTransformer () const
 Gets the transformer of the area. More...
 

Detailed Description

This class is used to represent an actual area where to print.

Library: ilvprint

Although this class may be used as is, it may be specialized by derivation by overloading the function print() or getBBox().

Constructor & Destructor Documentation

§ IlvPrintableActualArea()

IlvPrintableActualArea::IlvPrintableActualArea ( IlvPrintableLayout const &  layout,
IlvRect const &  bbox,
IlvTransformer const &  transformer 
)

The constructor.

Calls IlvPrintableArea::IlvPrintableArea(layout) and stores the bbox.

Parameters
layoutThe IlvPrintableLayout associated with this object.
bboxThe size of the area.
transformerThe transformer of the area.

Member Function Documentation

§ clone()

virtual IlvPrintableArea* IlvPrintableActualArea::clone ( ) const
virtual

Returns a pointer to a new instance of IlvPrintableActualArea; this object is a copy of the current object.

Returns
A pointer to a new IlvPrintableArea*.

Implements IlvPrintableArea.

§ getBBox()

IlvRect IlvPrintableActualArea::getBBox ( ) const
protected

Gets the size of the area.

This virtual function just returns the stored size. It may be overloaded in inherited classes.

Returns
The size of the area as an IlvRect.

§ getTransformer()

IlvTransformer IlvPrintableActualArea::getTransformer ( ) const
protected

Gets the transformer of the area.

This virtual function just returns the stored transformer. It may be overloaded in inherited classes.

Returns
The transformer of the area as an IlvTransformer.

§ print()

virtual IlBoolean IlvPrintableActualArea::print ( IlvPrintableJob job,
IlvPrintable printable 
) const
virtual

Prints the area.

This function overloads the print() member function of IlvPrintableArea. It calls the protected virtual function getBBox().

Parameters
jobThe current print settings.
printableThe IlvPrintable to be printed.
Returns
IlTrue if printing was successful.
See also
IlvPrintableArea::print().
IlvPrintableActualArea::getBBox().

Implements IlvPrintableArea.

§ setBBox()

virtual void IlvPrintableActualArea::setBBox ( IlvRect const &  bbox)
virtual

Sets the size of the area.

Overloads the IlvPrintableArea member function. It actually stores the bbox.

Parameters
bboxThe new size of the area.

Implements IlvPrintableArea.

§ setTransformer()

virtual void IlvPrintableActualArea::setTransformer ( IlvTransformer const &  transformer)
virtual

Sets the transformer of the area.

Overloads the IlvPrintableArea member function. It actually stores the transformer.

Parameters
transformerThe new transformer.

Implements IlvPrintableArea.


© Copyright 2018, Rogue Wave Software, Inc. All Rights Reserved.
Rogue Wave is a registered trademark of Rogue Wave Software, Inc. in the United States and other countries. All other trademarks are the property of their respective owners.