rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

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

List of all members.

Public Member Functions

 IlvPrintableActualArea (IlvPrintableLayout const &layout, IlvRect const &bbox, IlvTransformer const &transformer)
 The constructor.
virtual IlvPrintableAreaclone () const
 Returns a pointer to a new instance of IlvPrintableActualArea; this object is a copy of the current object.
virtual IlBoolean print (IlvPrintableJob &job, IlvPrintable *printable) const
 Prints the area.
virtual void setBBox (IlvRect const &bbox)
 Sets the size of the area.
virtual void setTransformer (IlvTransformer const &transformer)
 Sets the transformer of the area.

Protected Member Functions

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

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 ( IlvPrintableLayout const &  layout,
IlvRect const &  bbox,
IlvTransformer const &  transformer 
)

The constructor.

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

Parameters:
layout The IlvPrintableLayout associated with this object.
bbox The size of the area.
transformer The transformer of the area.

Member Function Documentation

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.

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.
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.
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:
job The current print settings.
Returns:
IlTrue if printing was successful.
See also:
IlvPrintableArea::print.
IlvPrintableActualArea::getBBox.

Implements IlvPrintableArea.

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:
bbox The new size of the area.

Implements IlvPrintableArea.

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:
transformer The new transformer.

Implements IlvPrintableArea.


© Copyright 2012, 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.