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 | Protected Member Functions
IlvPrintableContainer Class Reference

This class encapsulates an IlvContainer so that it can be printed with this library. More...

#include <ilviews/printing/printables.h>

Inheritance diagram for IlvPrintableContainer:
IlvPrintableScalable IlvPrintable

Public Member Functions

 IlvPrintableContainer (IlvContainer const *container, IlvRect const *scalableArea=0, IlvRegion const *clip=0, IlvTransformer const *t=0)
 The constructor. More...
 
IlvContainer const * getContainer () const
 Returns the container to be printed. More...
 
- Public Member Functions inherited from IlvPrintableScalable
 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...
 

Protected Member Functions

virtual IlBoolean internalPrint (IlvPrintableJob const &job) const
 This function actually prints the document. More...
 

Detailed Description

This class encapsulates an IlvContainer so that it can be printed with this library.

Library: ilvprint

See Also
IlvPrintableDocument::append

Constructor & Destructor Documentation

IlvPrintableContainer::IlvPrintableContainer ( IlvContainer const *  container,
IlvRect const *  scalableArea = 0,
IlvRegion const *  clip = 0,
IlvTransformer const *  t = 0 
)

The constructor.

Parameters
containerA const pointer to an IlvContainer.
scalableAreaA const pointer to an IlvRect that defines the area to be printed. If this pointer is null, the visible bbox is used.
clipA const pointer to an IlvRegion that defines the clip.
tA const pointer to an IlvTransformer that defines the transformer used by the drawing.

Member Function Documentation

IlvContainer const * IlvPrintableContainer::getContainer ( ) const

Returns the container to be printed.

Returns
The container to be printed.
virtual IlBoolean IlvPrintableContainer::internalPrint ( IlvPrintableJob const &  job) const
protectedvirtual

This function actually prints the document.

Parameters
jobThe settings of the current print job.
Returns
IlFalse if an error occurred during the printing, IlTrue otherwise.

Implements IlvPrintable.


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