rwlogo
Rogue Wave Views 5.6

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

List of all members | Public Member Functions
IlvPrintableScalable Class Reference

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

#include <ilviews/printing/printable.h>

Inheritance diagram for IlvPrintableScalable:
IlvPrintable IlvPrintableContainer IlvPrintableGraphic

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...
 
IlvPrintableoperator= (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 ( IlvRect const &  scalableArea,
IlvRegion const *  clip = 0,
IlvTransformer const *  t = 0 
)

The default constructor.

Parameters
scalableAreaThe area to be printed.
clipAn optional rectangle used to clip the drawing.
tAn optional transformer used by the drawing.

Member Function Documentation

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

Gets the bounding box of the area to print.

Parameters
jobThe settings of the current print job.
Returns
The bounding box.

Implements IlvPrintable.

IlvRegion const & IlvPrintableScalable::getClip ( ) const

Returns the clip size.

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

Returns
The clip size.
IlvRect const & IlvPrintableScalable::getScalableArea ( ) const

Returns the area to be printed.

Returns
The area to be printed.
IlvTransformer const * IlvPrintableScalable::getTransformer ( ) const

Gets the transformer to be used by the drawing.

Returns
A const pointer to an IlvTransformer.
IlBoolean IlvPrintableScalable::hasClip ( ) const

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

Returns
IlTrue if a clip was given, IlFalse otherwise.
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.
void IlvPrintableScalable::resetClip ( )

Resets the clip.

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

void IlvPrintableScalable::resetTransformer ( )

Resets the transformer.

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

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
clipThe clip size.
void IlvPrintableScalable::setScalableArea ( IlvRect const &  scalableArea)

Sets the area to be printed.

Parameters
scalableAreaThe area to be printed.
void IlvPrintableScalable::setTransformer ( IlvTransformer const *  t)

Sets the transformer to be used by the drawing.

Parameters
tA const pointer to an IlvTransformer.

© 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.