Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Class for printing to a PostScript printer. More...
#include <ilviews/printing/psprinter.h>
Classes | |
class | DialogHandle |
Class to handle a dialog to initialize or modify the settings. More... | |
Public Member Functions | |
IlvPSPrinter (IlvDisplay *display) | |
Constructor. More... | |
~IlvPSPrinter () | |
Destructor. More... | |
virtual IlBoolean | checkErrorStatus () const |
Checks the error status of the printer. More... | |
DialogHandle * | getDialogHandle (IlvDisplay *display) const |
Gets the dialog handle. More... | |
virtual IlvDim | getPaperHeight () const |
Returns the height of the paper. More... | |
virtual IlvRect | getPaperSize () const |
Returns the size of the paper. More... | |
virtual IlvDim | getPaperWidth () const |
Returns the width of the paper. More... | |
virtual IlvRect | getUsableArea () const |
Returns the physical printable area. More... | |
virtual IlBoolean | initializeSettings () |
Initializes the settings of the printer. More... | |
IlvPort * | makePort () const |
Creates the printer port used in this class. More... | |
void | setDialogHandle (DialogHandle *dialogHandle, IlBoolean owner=IlTrue) |
Sets the dialog handle. More... | |
Public Member Functions inherited from IlvPrinter | |
IlvPrinter (IlvDisplay *display) | |
Constructor. More... | |
virtual | ~IlvPrinter () |
Destructor. More... | |
void | end () |
Closes the dump device. More... | |
void | forceDialogDisplay (IlBoolean force) |
Sets whether the dialog must be displayed. More... | |
IlvRegion const * | getClip () const |
Gets the current clip of the printer. More... | |
IlvDisplay * | getDisplay () const |
Returns the display. More... | |
IlString | getDocumentName () const |
Returns the document name. More... | |
IlvRect const * | getInitClip () const |
Gets the global clip of the printer. More... | |
void | getMargins (IlvDim &left, IlvDim &right, IlvDim &top, IlvDim &bottom) const |
Returns the printer's physical margins. More... | |
Orientation | getOrientation () const |
Returns the printing orientation. More... | |
IlvPaperFormat const & | getPaperFormat () const |
Returns the paper format. More... | |
IlvPort * | getPort () const |
Returns the printer port. More... | |
IlvTransformer const & | getTransformer () const |
Gets the current transformer of the printer. More... | |
void | initClip (IlvRect const &newClip) |
Sets the global clip of the printer. More... | |
IlBoolean | initialize () |
Initializes the dump device. More... | |
IlBoolean | isDialogDisplayForced () const |
Returns whether the dialog must be displayed. More... | |
IlBoolean | isDumping () const |
Returns the dumping status. More... | |
void | setClip (IlvRegion const *newClip) |
Sets a new clip to the printer. More... | |
void | setClip (IlvRect const &newClip) |
Sets a new clip to the printer. More... | |
void | setDocumentName (IlString const &name) |
Sets the document name. More... | |
void | setMargins (IlvDim left, IlvDim right, IlvDim top, IlvDim bottom) |
Sets the physical margins for the printer. More... | |
void | setOrientation (Orientation orientation) |
Sets the printing orientation. More... | |
void | setPaperFormat (IlvPaperFormat const &format) |
Sets the paper format. More... | |
void | setPort (IlvPort *port) |
Sets the port used when printing on a real printer. More... | |
void | setTransformer (IlvTransformer const &newTransformer) |
Sets a new transformer to the printer. More... | |
Protected Member Functions | |
virtual void | internalInitClip (IlvRect const &newClip) |
Sets a new clip to the printer. More... | |
virtual IlBoolean | internalInitialize () |
Does specific initialization for the dump device. More... | |
virtual void | internalSetClip (IlvRegion const *newClip) |
Sets a new clip to the printer. More... | |
virtual void | internalSetMargins (IlvDim left, IlvDim right, IlvDim top, IlvDim bottom) |
Implements the actual physical margins for the printer. More... | |
virtual void | internalSetOrientation (Orientation orient) |
Implements the actual printing orientation change. More... | |
virtual void | internalSetPaperFormat (IlvPaperFormat const &format) |
Implements the actual paper format selection. More... | |
virtual void | internalSetTransformer (IlvTransformer const &transformer) |
Sets a new transformer to the printer. More... | |
Protected Member Functions inherited from IlvPrinter | |
void | setDumpingStatus (IlBoolean status) |
Sets the dumping status. More... | |
Additional Inherited Members | |
Public Types inherited from IlvPrinter |
Class for printing to a PostScript printer.
Library: ilvprint
The default margin is 0.5 inches on each side.
Examples using this class are provided in the samples/foundation/printing directory.
IlvPostScriptPrinterDialog
IlvPSPrinter::IlvPSPrinter | ( | IlvDisplay * | display | ) |
Constructor.
Initializes a new instance of IlvPSPrinter
.
IlvPSPrinter::~IlvPSPrinter | ( | ) |
Destructor.
The destructor releases all the memory used by the instance.
|
virtual |
Checks the error status of the printer.
IlTrue
when the status is no error, IlFalse
otherwise. Implements IlvPrinter.
IlvPSPrinter::DialogHandle * IlvPSPrinter::getDialogHandle | ( | IlvDisplay * | display | ) | const |
Gets the dialog handle.
This dialog handle, if it exists, is used to initialize or modify the settings.
display | A pointer to an IlvDisplay . |
DialogHandle
.
|
virtual |
|
virtual |
|
virtual |
|
virtual |
Returns the physical printable area.
This is the real size of a sheet of paper minus the printer's borders.
Implements IlvPrinter.
|
virtual |
Initializes the settings of the printer.
IlFalse
if an error occurred, IlTrue
otherwise. Implements IlvPrinter.
|
protectedvirtual |
Sets a new clip to the printer.
This function is called by IlvPrinter::setClip
.
newClip | The new clip. |
IlvPrinter::setClip
. Implements IlvPrinter.
|
protectedvirtual |
Does specific initialization for the dump device.
IlFalse
if an error occurred, IlTrue
otherwise. initialize()
. Implements IlvPrinter.
|
protectedvirtual |
Sets a new clip to the printer.
This function is called by IlvPrinter::setClip
.
newClip | The new clip. |
IlvPrinter::setClip
. Implements IlvPrinter.
|
protectedvirtual |
Implements the actual physical margins for the printer.
left | The left margin. |
right | The right margin. |
top | The top margin. |
bottom | The bottom margin. |
Implements IlvPrinter.
|
protectedvirtual |
Implements the actual printing orientation change.
orient | The new orientation. |
Implements IlvPrinter.
|
protectedvirtual |
Implements the actual paper format selection.
format | The new paper format. |
Implements IlvPrinter.
|
protectedvirtual |
Sets a new transformer to the printer.
This function is called by IlvPrinter::setTransformer
.
transformer | The new transformer. |
IlvPrinter::setTransformer
. Implements IlvPrinter.
|
virtual |
void IlvPSPrinter::setDialogHandle | ( | IlvPSPrinter::DialogHandle * | dialogHandle, |
IlBoolean | owner = IlTrue |
||
) |
Sets the dialog handle.
This dialog handle, if it exists, is used to initialize or modify the settings.
dialogHandle | A pointer to a DialogHandle . |
owner | If IlTrue the current object must delete the dialogHandle given as parameter. |
© 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.