Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Class of printing settings. More...
#include <ilviews/printing/printable.h>
Public Member Functions | |
IlvPrintableJob (IlvPrinter &printer) | |
The constructor. More... | |
IlvPrintableJob (IlvPrintableJob const &other) | |
The copy constructor. More... | |
int | getAllPageNumber () const |
Gets the number of pages of the whole document. More... | |
IlvRect | getBBox () const |
Gets the bounding box of the area where to print. More... | |
int | getFirstPageIndex () const |
Gets the index of the first page to be printed. More... | |
int | getLastPageIndex () const |
Gets the index of one past the last page to be printed. More... | |
int | getPageCount () const |
Gets the number of pages to be printed. More... | |
int | getPageIndex () const |
Gets the index of the page to be printed. More... | |
int | getPageNumber () const |
Gets the number of the page to be printed. More... | |
IlvPrintable * | getPrintable () const |
Gets the current printable to be printed. More... | |
IlvPrinter & | getPrinter () const |
Gets the printer for the current job. More... | |
IlvTransformer | getTransformer () const |
Gets the transformer computed by the IlvPrintableLayout . More... | |
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. More... | |
void | setPrintable (IlvPrintable *printable) |
Sets the current printable to be printed. More... | |
void | setTransformer (IlvTransformer const &transformer) |
Sets the transformer computed by the IlvPrintableLayout . More... | |
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.
IlvPrintableJob::IlvPrintableJob | ( | IlvPrinter & | printer | ) |
The constructor.
printer | The printer to print on. |
IlvPrintableJob::IlvPrintableJob | ( | IlvPrintableJob const & | other | ) |
The copy constructor.
other | The job to be copied. |
int IlvPrintableJob::getAllPageNumber | ( | ) | const |
Gets 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.
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
.
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
.
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
.
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
.
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
.
IlvPrintable * IlvPrintableJob::getPrintable | ( | ) | const |
Gets the current printable to be printed.
IlvPrinter & IlvPrintableJob::getPrinter | ( | ) | const |
Gets the printer for the current job.
IlvTransformer IlvPrintableJob::getTransformer | ( | ) | const |
Gets the transformer computed by the IlvPrintableLayout
.
IlvPrintableLayout
. void IlvPrintableJob::setBBox | ( | IlvRect const & | bbox | ) |
Sets the bounding box of the area where to print.
bbox | The bounding box of the area where to print. |
void IlvPrintableJob::setPrintable | ( | IlvPrintable * | printable | ) |
Sets the current printable to be printed.
printable | The current printable to be printed. |
void IlvPrintableJob::setTransformer | ( | IlvTransformer const & | transformer | ) |
Sets the transformer computed by the IlvPrintableLayout
.
transformer | The transformer computed by the IlvPrintableLayout . |
© Copyright 2016, 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.