rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPrintableJob Class Reference

Class of printing settings. More...

#include <ilviews/printing/printable.h>

List of all members.

Public Member Functions

 IlvPrintableJob (IlvPrintableJob const &other)
 The copy constructor.
 IlvPrintableJob (IlvPrinter &printer)
 The constructor.
int getAllPageNumber () const
 Gets the number of pages of the whole document.
IlvRect getBBox () const
 Gets the bounding box of the area where to print.
int getFirstPageIndex () const
 Gets the index of the first page to be printed.
int getLastPageIndex () const
 Gets the index of one past the last page to be printed.
int getPageCount () const
 Gets the number of pages to be printed.
int getPageIndex () const
 Gets the index of the page to be printed.
int getPageNumber () const
 Gets the number of the page to be printed.
IlvPrintablegetPrintable () const
 Gets the current printable to be printed.
IlvPrintergetPrinter () const
 Gets the printer for the current job.
IlvTransformer getTransformer () const
 Gets the transformer computed by the IlvPrintableLayout.
void incPageIndex ()
 Increments the index of the page to be printed.
void setBBox (IlvRect const &bbox)
 Sets the bounding box of the area where to print.
void setPrintable (IlvPrintable *printable)
 Sets the current printable to be printed.
void setTransformer (IlvTransformer const &transformer)
 Sets the transformer computed by the IlvPrintableLayout.

Detailed Description

Class of printing settings.

Library: ilvprint

This class is used to store the settings for the current print job. It is used as a parameter of the print functions of the different classes of this framework.


Constructor & Destructor Documentation

IlvPrintableJob::IlvPrintableJob ( IlvPrinter printer  ) 

The constructor.

Parameters:
printer The printer to print on.
IlvPrintableJob::IlvPrintableJob ( IlvPrintableJob const &  other  ) 

The copy constructor.

Parameters:
other The job to be copied.

Member Function Documentation

int IlvPrintableJob::getAllPageNumber (  )  const

Gets the number of pages of the whole document.

Returns:
The number of pages of the whole document.
IlvRect IlvPrintableJob::getBBox (  )  const

Gets the bounding box of the area where to print.

Note that this area is also used as the clip.

Returns:
The bounding box of the area where to print.
int IlvPrintableJob::getFirstPageIndex (  )  const

Gets the index of the first page to be printed.

The index is relative to the beginning of the document. The index of the first page of the document is 0.

Returns:
The index of the first page to be printed.
int IlvPrintableJob::getLastPageIndex (  )  const

Gets the index of one past the last page to be printed.

The index is relative to the beginning of the document. The index of the first page of the document is 0.

Returns:
The index of one past the last page to be printed.
int IlvPrintableJob::getPageCount (  )  const

Gets the number of pages to be printed.

The number is either the number of pages of the whole document when the mode is absolute, or only the number of pages to be printed. The number of the first page of the document is 1.

Returns:
The number of pages to be printed.
int IlvPrintableJob::getPageIndex (  )  const

Gets the index of the page to be printed.

This is the index from the beginning of the document. The index of the first page of the document is 1.

Returns:
The index of the page to be printed.
int IlvPrintableJob::getPageNumber (  )  const

Gets the number of the page to be printed.

The number is either relative to the beginning of the document when the mode is absolute, or to the first page to be printed. The number of the first page of the document is 1.

Returns:
The number of the page to be printed.
IlvPrintable * IlvPrintableJob::getPrintable (  )  const

Gets the current printable to be printed.

Returns:
A pointer to the current printable to be printed.
IlvPrinter & IlvPrintableJob::getPrinter (  )  const

Gets the printer for the current job.

Returns:
A reference to the printer for the current job.
IlvTransformer IlvPrintableJob::getTransformer (  )  const

Gets the transformer computed by the IlvPrintableLayout.

Returns:
The transformer computed by the IlvPrintableLayout.
void IlvPrintableJob::setBBox ( IlvRect const &  bbox  ) 

Sets the bounding box of the area where to print.

Parameters:
bbox The bounding box of the area where to print.
void IlvPrintableJob::setPrintable ( IlvPrintable printable  ) 

Sets the current printable to be printed.

Parameters:
printable The current printable to be printed.
void IlvPrintableJob::setTransformer ( IlvTransformer const &  transformer  ) 

Sets the transformer computed by the IlvPrintableLayout.

Parameters:
transformer The transformer computed by the IlvPrintableLayout.

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