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 | Classes | Public Member Functions | Protected Member Functions
IlvPSPrinter Class Reference

Class for printing to a PostScript printer. More...

#include <ilviews/printing/psprinter.h>

Inheritance diagram for IlvPSPrinter:
IlvPrinter

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...
 
DialogHandlegetDialogHandle (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...
 
IlvPortmakePort () 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...
 
IlvDisplaygetDisplay () 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...
 
IlvPortgetPort () 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
enum  Orientation { , Portrait, Landscape }
 This enumeration defines the possible values for the printing orientation. More...
 

Detailed Description

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.

See Also
IlvPostScriptPrinterDialog

Constructor & Destructor Documentation

IlvPSPrinter::IlvPSPrinter ( IlvDisplay display)

Constructor.

Initializes a new instance of IlvPSPrinter.

IlvPSPrinter::~IlvPSPrinter ( )

Destructor.

The destructor releases all the memory used by the instance.

Member Function Documentation

virtual IlBoolean IlvPSPrinter::checkErrorStatus ( ) const
virtual

Checks the error status of the printer.

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

Parameters
displayA pointer to an IlvDisplay.
Returns
A pointer to the current DialogHandle.
virtual IlvDim IlvPSPrinter::getPaperHeight ( ) const
virtual

Returns the height of the paper.

Returns
The height of the paper.

Implements IlvPrinter.

virtual IlvRect IlvPSPrinter::getPaperSize ( ) const
virtual

Returns the size of the paper.

Returns
The size of the paper.

Implements IlvPrinter.

virtual IlvDim IlvPSPrinter::getPaperWidth ( ) const
virtual

Returns the width of the paper.

Returns
The width of the paper.

Implements IlvPrinter.

virtual IlvRect IlvPSPrinter::getUsableArea ( ) const
virtual

Returns the physical printable area.

This is the real size of a sheet of paper minus the printer's borders.

Returns
The usable physical printable area.

Implements IlvPrinter.

virtual IlBoolean IlvPSPrinter::initializeSettings ( )
virtual

Initializes the settings of the printer.

Returns
IlFalse if an error occurred, IlTrue otherwise.

Implements IlvPrinter.

virtual void IlvPSPrinter::internalInitClip ( IlvRect const &  newClip)
protectedvirtual

Sets a new clip to the printer.

This function is called by IlvPrinter::setClip.

Parameters
newClipThe new clip.
See Also
IlvPrinter::setClip.

Implements IlvPrinter.

virtual IlBoolean IlvPSPrinter::internalInitialize ( )
protectedvirtual

Does specific initialization for the dump device.

Returns
IlFalse if an error occurred, IlTrue otherwise.
See Also
initialize().

Implements IlvPrinter.

virtual void IlvPSPrinter::internalSetClip ( IlvRegion const *  newClip)
protectedvirtual

Sets a new clip to the printer.

This function is called by IlvPrinter::setClip.

Parameters
newClipThe new clip.
See Also
IlvPrinter::setClip.

Implements IlvPrinter.

virtual void IlvPSPrinter::internalSetMargins ( IlvDim  left,
IlvDim  right,
IlvDim  top,
IlvDim  bottom 
)
protectedvirtual

Implements the actual physical margins for the printer.

Parameters
leftThe left margin.
rightThe right margin.
topThe top margin.
bottomThe bottom margin.

Implements IlvPrinter.

virtual void IlvPSPrinter::internalSetOrientation ( Orientation  orient)
protectedvirtual

Implements the actual printing orientation change.

Parameters
orientThe new orientation.

Implements IlvPrinter.

virtual void IlvPSPrinter::internalSetPaperFormat ( IlvPaperFormat const &  format)
protectedvirtual

Implements the actual paper format selection.

Parameters
formatThe new paper format.

Implements IlvPrinter.

virtual void IlvPSPrinter::internalSetTransformer ( IlvTransformer const &  transformer)
protectedvirtual

Sets a new transformer to the printer.

This function is called by IlvPrinter::setTransformer.

Parameters
transformerThe new transformer.
See Also
IlvPrinter::setTransformer.

Implements IlvPrinter.

IlvPort* IlvPSPrinter::makePort ( ) const
virtual

Creates the printer port used in this class.

Returns
The printer port.

Implements IlvPrinter.

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.

Parameters
dialogHandleA pointer to a DialogHandle.
ownerIf IlTrue the current object must delete the dialogHandle given as parameter.

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