Class for printing on the Windows printer. More...

#include <ilviews/printing/wprinter.h>

Inheritance diagram for IlvWindowsPrinter:

Public Member Functions
	IlvWindowsPrinter (IlvDisplay *display)
	Constructor. More...

	~IlvWindowsPrinter ()
	Destructor. More...

virtual IlBoolean	checkErrorStatus () const
	Checks the error status of the printer. 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...

IlvWindowsPrinterDCFactory *	getPrinterDCFactory () const
	Gets the Windows printer factory. 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	setPrinterDCFactory (IlvWindowsPrinterDCFactory *factory)
	Sets the Windows printer factory. More...

void	setPrinterDescription (char const *printerDescription)
	Sets the Windows printer description. 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 (IlvRect const &newClip)
	Sets a new clip to the printer. More...

void	setClip (IlvRegion 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	internalEnd ()
	Performs specific cleanup for the dump device. More...

virtual void	internalInitClip (IlvRect const &newClip)
	Sets a new clip to the printer. More...

virtual IlBoolean	internalInitialize ()
	Does specific initializations 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 on the Windows printer.

Library: ilvprint

There are two different ways to set the windows printer that you want to target: either by calling setPrinterDescription() or by setting an IlvWindowsPrinterDCFactory instance to this IlvWindowsPrinter object.

Examples using this class are provided in the samples/foundation/printing directory.

See also: IlvPrinter, setPrinterDCFactory().

Constructor & Destructor Documentation

◆ IlvWindowsPrinter()

IlvWindowsPrinter::IlvWindowsPrinter ( IlvDisplay * display )

Constructor.

Initializes a new instance of IlvWindowsPrinter.

◆ ~IlvWindowsPrinter()

IlvWindowsPrinter::~IlvWindowsPrinter ( )

Destructor.

The destructor releases all the memory used by the instance.

Member Function Documentation

◆ checkErrorStatus()

virtual IlBoolean IlvWindowsPrinter::checkErrorStatus ( ) const

virtual

Checks the error status of the printer.

Returns: IlTrue when the status is no error, IlFalse otherwise.

Implements IlvPrinter.

◆ getPaperHeight()

virtual IlvDim IlvWindowsPrinter::getPaperHeight ( ) const

virtual

Returns the height of the paper.

Before using this method,the internal attributes of the IlvWindowsPrinter instance must be initialized through a call to IlvPrinter::initializeSettings().

Returns: The height of the paper.

Implements IlvPrinter.

◆ getPaperSize()

virtual IlvRect IlvWindowsPrinter::getPaperSize ( ) const

virtual

Returns the size of the paper.

Before using this method,the internal attributes of the IlvWindowsPrinter instance must be initialized through a call to IlvPrinter::initializeSettings().

Returns: The size of the paper.

Implements IlvPrinter.

◆ getPaperWidth()

virtual IlvDim IlvWindowsPrinter::getPaperWidth ( ) const

virtual

Returns the width of the paper.

Before using this method,the internal attributes of the IlvWindowsPrinter instance must be initialized through a call to IlvPrinter::initializeSettings().

Returns: The width of the paper.

Implements IlvPrinter.

◆ getPrinterDCFactory()

IlvWindowsPrinterDCFactory* IlvWindowsPrinter::getPrinterDCFactory ( ) const

Gets the Windows printer factory.

Returns: The factory used to create the printer DC if no printer description is given.

◆ getUsableArea()

virtual IlvRect IlvWindowsPrinter::getUsableArea ( ) const

virtual

Returns the physical printable area.

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

Before using this method,the internal attributes of the IlvWindowsPrinter instance must be initialized through a call to IlvPrinter::initializeSettings().

Returns: The usable physical printable area.

See also: IlvPrinter::initializeSettings().

Implements IlvPrinter.

◆ initializeSettings()

virtual IlBoolean IlvWindowsPrinter::initializeSettings ( )

virtual

Initializes the settings of the printer.

If a printer has been chosen using the setPrinterDescription() method and an IlvWindowsPrinterDCFactory instance has also been set on this IlvWindowsPrinter object, then most of the settings set in the factory will be ignored. Only the printing orientation set in the factory will be taken into account.

Returns: IlFalse if an error occurred, IlTrue otherwise.

See also: setPrinterDCFactory().

Implements IlvPrinter.

◆ internalEnd()

virtual void IlvWindowsPrinter::internalEnd ( )

protectedvirtual

Performs specific cleanup for the dump device.

The IlvWindowsPrinter implementation is not required to do anything.

See also: internalInitialize().

Implements IlvPrinter.

◆ internalInitClip()

virtual void IlvWindowsPrinter::internalInitClip ( IlvRect const & newClip )

protectedvirtual

Sets a new clip to the printer.

This function is called by IlvPrinter::setClip.

Parameters

newClip The new clip.

Implements IlvPrinter.

◆ internalInitialize()

virtual IlBoolean IlvWindowsPrinter::internalInitialize ( )

protectedvirtual

Does specific initializations for the dump device.

Returns: IlFalse if an error occurred, IlTrue otherwise.

See also: initialize().

Implements IlvPrinter.

◆ internalSetClip()

virtual void IlvWindowsPrinter::internalSetClip ( IlvRegion const * newClip )

protectedvirtual

Sets a new clip to the printer.

This function is called by IlvPrinter::setClip().

Parameters

newClip The new clip.

Implements IlvPrinter.

◆ internalSetMargins()

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

protectedvirtual

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.

◆ internalSetOrientation()

virtual void IlvWindowsPrinter::internalSetOrientation ( Orientation orient )

protectedvirtual

Implements the actual printing orientation change.

Parameters

orient The new orientation.

Implements IlvPrinter.

◆ internalSetPaperFormat()

virtual void IlvWindowsPrinter::internalSetPaperFormat ( IlvPaperFormat const & format )

protectedvirtual

Implements the actual paper format selection.

Parameters

format The new paper format.

Implements IlvPrinter.

◆ internalSetTransformer()

virtual void IlvWindowsPrinter::internalSetTransformer ( IlvTransformer const & transformer )

protectedvirtual

Sets a new transformer to the printer.

This function is called by IlvPrinter::setTransformer().

Parameters

transformer The new transformer.

Implements IlvPrinter.

◆ makePort()

IlvPort* IlvWindowsPrinter::makePort ( ) const

virtual

Creates the printer port used in this class.

Returns: The printer port.

Implements IlvPrinter.

◆ setPrinterDCFactory()

void IlvWindowsPrinter::setPrinterDCFactory ( IlvWindowsPrinterDCFactory * factory )

Sets the Windows printer factory.

If a printer has been chosen using the setPrinterDescription() method, then only the printing orientation set in the factory will be taken into account. All the other settings set in the factory will be ignored.

Parameters

factory The new factory used to create the printer DC if no printer description is given. This object is not responsible for the destruction of the factory.

◆ setPrinterDescription()

void IlvWindowsPrinter::setPrinterDescription ( char const * printerDescription )

Sets the Windows printer description.

Parameters

printerDescription The Windows description of the printer. It typically comes from IlvGetWindowsPrinter.

See also: IlvGetWindowsPrinter.

Public Member Functions

Protected Member Functions

Additional Inherited Members

Detailed Description

Constructor & Destructor Documentation

◆ IlvWindowsPrinter()

◆ ~IlvWindowsPrinter()

Member Function Documentation

◆ checkErrorStatus()

◆ getPaperHeight()

◆ getPaperSize()

◆ getPaperWidth()

◆ getPrinterDCFactory()

◆ getUsableArea()

◆ initializeSettings()

◆ internalEnd()

◆ internalInitClip()

◆ internalInitialize()

◆ internalSetClip()

◆ internalSetMargins()

◆ internalSetOrientation()

◆ internalSetPaperFormat()

◆ internalSetTransformer()

◆ makePort()

◆ setPrinterDCFactory()

◆ setPrinterDescription()