rwlogo
Rogue Wave Views 5.5.1

Rogue Wave Views
Foundation Package API Reference Guide

Product Documentation:

Rogue Wave Views
Documentation Home

IlvPSPrinter Class Reference

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

#include <ilviews/printing/psprinter.h>

Inheritance diagram for IlvPSPrinter:
IlvPrinter

List of all members.

Classes

class  DialogHandle
 Class to handle a dialog to initialize or modify the settings. More...

Public Member Functions

 IlvPSPrinter (IlvDisplay *display)
 Constructor.
 ~IlvPSPrinter ()
 Destructor.
virtual IlBoolean checkErrorStatus () const
 Checks the error status of the printer.
DialogHandlegetDialogHandle (IlvDisplay *display) const
 Gets the dialog handle.
virtual IlvDim getPaperHeight () const
 Returns the height of the paper.
virtual IlvRect getPaperSize () const
 Returns the size of the paper.
virtual IlvDim getPaperWidth () const
 Returns the width of the paper.
virtual IlvRect getUsableArea () const
 Returns the physical printable area.
virtual IlBoolean initializeSettings ()
 Initializes the settings of the printer.
IlvPortmakePort () const
 Creates the printer port used in this class.
void setDialogHandle (DialogHandle *dialogHandle, IlBoolean owner=((IlBoolean) 1))
 Sets the dialog handle.

Protected Member Functions

virtual void internalInitClip (IlvRect const &newClip)
 Sets a new clip to the printer.
virtual IlBoolean internalInitialize ()
 Does specific initialization for the dump device.
virtual void internalSetClip (IlvRegion const *newClip)
 Sets a new clip to the printer.
virtual void internalSetMargins (IlvDim left, IlvDim right, IlvDim top, IlvDim bottom)
 Implements the actual physical margins for the printer.
virtual void internalSetOrientation (Orientation orient)
 Implements the actual printing orientation change.
virtual void internalSetPaperFormat (IlvPaperFormat const &format)
 Implements the actual paper format selection.
virtual void internalSetTransformer (IlvTransformer const &transformer)
 Sets a new transformer to the printer.

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:
display A 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  )  [protected, virtual]

Sets a new clip to the printer.

This function is called by IlvPrinter::setClip.

Parameters:
newClip The new clip.
See also:
IlvPrinter::setClip.

Implements IlvPrinter.

virtual IlBoolean IlvPSPrinter::internalInitialize (  )  [protected, virtual]

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  )  [protected, virtual]

Sets a new clip to the printer.

This function is called by IlvPrinter::setClip.

Parameters:
newClip The new clip.
See also:
IlvPrinter::setClip.

Implements IlvPrinter.

virtual void IlvPSPrinter::internalSetMargins ( IlvDim  left,
IlvDim  right,
IlvDim  top,
IlvDim  bottom 
) [protected, virtual]

Implements the actual physical margins for the printer.

Parameters:
left The left margin.
right The right margin.
top The top margin.
bottom The bottom margin.

Implements IlvPrinter.

virtual void IlvPSPrinter::internalSetOrientation ( Orientation  orient  )  [protected, virtual]

Implements the actual printing orientation change.

Parameters:
orient The new orientation.

Implements IlvPrinter.

virtual void IlvPSPrinter::internalSetPaperFormat ( IlvPaperFormat const &  format  )  [protected, virtual]

Implements the actual paper format selection.

Parameters:
format The new paper format.

Implements IlvPrinter.

virtual void IlvPSPrinter::internalSetTransformer ( IlvTransformer const &  transformer  )  [protected, virtual]

Sets a new transformer to the printer.

This function is called by IlvPrinter::setTransformer.

Parameters:
transformer The 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 = ((IlBoolean)1) 
)

Sets the dialog handle.

This dialog handle, if it exists, is used to initialize or modify the settings.

Parameters:
dialogHandle A pointer to a DialogHandle.
owner If 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.