IlvWindowsPrinterDCDialogFactory Class Reference

Windows-specific class to create a printer device context from the Windows dialog. More...

#include <ilviews/windows/dump.h>

Inheritance diagram for IlvWindowsPrinterDCDialogFactory:

List of all members.

Public Member Functions
	IlvWindowsPrinterDCDialogFactory ()
	The default constructor.
virtual IlBoolean	getFirstLastPages (IlUShort &first, IlUShort &last) const
	Gets the first and last number of the pages to be printed.
virtual HDC	getHDC () const
	Gets the printer HDC.
virtual IlBoolean	getMinMaxPageRange (IlUShort &min, IlUShort &max) const
	Gets the extremum values for the page range.
virtual short	getOrientation () const
	Gets the orientation of the paper for the current settings of the printer.
virtual short	getPaperLength () const
	Gets the overridden length of the paper.
virtual short	getPaperSize () const
	Gets the size of the paper.
virtual short	getPaperWidth () const
	Gets the overridden width of the paper.
virtual IlBoolean	hasPageSettingDialog () const
	Returns an indication of whether a dialog that manages page numbers is used.
virtual IlBoolean	initializeSettings ()
	Initializes the printer settings used to create the DC.
virtual IlBoolean	isVisible () const
	Gets the visibility of the dialog if any.
virtual void	resetSettings ()
	Resets the printer settings used to create the printer DC.
virtual void	setFirstLastPages (IlUShort first, IlUShort last)
	Sets the value of the first and last pages to be printed.
virtual void	setMinMaxPageRange (IlUShort minPage, IlUShort maxPage)
	Sets the extremum values for the page range.
virtual void	setOrientation (short newOrientation, IlvDisplay &display)
	Sets the orientation of the paper for the current settings of the printer.
virtual void	setPaperLength (short length, IlvDisplay &display)
	Overrides the length of the paper.
virtual void	setPaperSize (short paperSize, IlvDisplay &display)
	Sets the size of the paper.
virtual void	setPaperWidth (short width, IlvDisplay &display)
	Overrides the width of the paper.
void	setTransientView (IlvSystemView view)
	Sets the owner view of the dialog.
virtual void	setVisibility (IlBoolean isVisible)
	Sets the visibility of the dialog if any.
virtual void	usePageSettingDialog (IlBoolean use)
	Sets an indication of whether a dialog that manages page numbers is used.
Protected Member Functions
PRINTDLG &	getPrintDLG () const
	This functions returns a reference to the PRINTDLG structure used by the dialog.

---

Detailed Description

Windows-specific class to create a printer device context from the Windows dialog.

Library: display

This class lets the user specify how to create the printer device context by displaying the Windows dialog to parameterize the printers.

See also:

IlvWindowsPrinter::setPrinterDCFactory

IlvWindowsDevice::setPrinterDCFactory

---

Member Function Documentation

virtual IlBoolean IlvWindowsPrinterDCDialogFactory::getFirstLastPages	(	IlUShort &	firstPage,
		IlUShort &	lastPage
	)			const [virtual]

Gets the first and last number of the pages to be printed.

This function stores the values (counted from 1) in its parameters. It returns a Boolean that indicates whether the values were filled in the dialog.

Parameters:

	firstPage	A reference to an IlUShort where the number of the first page to be printed (counted from 1) is stored.
	lastPage	A reference to an IlUShort where the number of the last page to be printed (counted from 1) is stored.

Returns:

A Boolean that indicates whether the values were filled in the dialog.

Implements IlvWindowsPrinterDCFactory.

virtual HDC IlvWindowsPrinterDCDialogFactory::getHDC

(

)

const [virtual]

Gets the printer HDC.

This pure virtual function must be overloaded in inherited classes.

The caller must delete the returned HDC when it is no longer needed.

Returns:

0 when an error occurred, or a valid HDC otherwise.

Implements IlvWindowsPrinterDCFactory.

virtual IlBoolean IlvWindowsPrinterDCDialogFactory::getMinMaxPageRange	(	IlUShort &	minPage,
		IlUShort &	maxPage
	)			const [virtual]

Gets the extremum values for the page range.

This function stores the values in its parameters. It returns a Boolean that indicates whether the values are used by the dialog.

Parameters:

	minPage	A reference to an IlUShort where the minimum value is stored.
	maxPage	A reference to an IlUShort where the maximum value is stored.

Returns:

A Boolean that indicates whether the values are used by the dialog.

Implements IlvWindowsPrinterDCFactory.

virtual short IlvWindowsPrinterDCDialogFactory::getOrientation

(

)

const [virtual]

Gets the orientation of the paper for the current settings of the printer.

This pure virtual function must be overloaded in inherited classes.

The values are the same as the ones specified in the member dmOrientation of the Windows structure DEVMODE.

Returns:

The orientation of the paper.

Implements IlvWindowsPrinterDCFactory.

virtual short IlvWindowsPrinterDCDialogFactory::getPaperLength

(

)

const [virtual]

Gets the overridden length of the paper.

The value is specified in tenths of a millimeter.

Returns:

The overridden length of the paper.

Implements IlvWindowsPrinterDCFactory.

virtual short IlvWindowsPrinterDCDialogFactory::getPaperSize

(

)

const [virtual]

Gets the size of the paper.

The values are the same as the ones specified in the member dmPaperSize of the Windows structure DEVMODE.

Returns:

The size of the paper.

Implements IlvWindowsPrinterDCFactory.

virtual short IlvWindowsPrinterDCDialogFactory::getPaperWidth

(

)

const [virtual]

Gets the overridden width of the paper.

The value is specified in tenths of a millimeter.

Returns:

The overridden width of the paper.

Implements IlvWindowsPrinterDCFactory.

PRINTDLG & IlvWindowsPrinterDCDialogFactory::getPrintDLG

(

)

const [protected]

This functions returns a reference to the PRINTDLG structure used by the dialog.

This allows inherited classes to modify the initialization of the dialog.

Returns:

A reference to the PRINTDLG structure used by the dialog.

virtual IlBoolean IlvWindowsPrinterDCDialogFactory::hasPageSettingDialog

(

)

const [virtual]

Returns an indication of whether a dialog that manages page numbers is used.

Returns:

Returns IlTrue when a dialog that manages page numbers is used, IlFalse else.

Implements IlvWindowsPrinterDCFactory.

virtual IlBoolean IlvWindowsPrinterDCDialogFactory::initializeSettings

(

)

[virtual]

Initializes the printer settings used to create the DC.

This pure virtual function must be overloaded in inherited classes.

Returns:

IlFalse when canceled, otherwise IlTrue.

Implements IlvWindowsPrinterDCFactory.

virtual IlBoolean IlvWindowsPrinterDCDialogFactory::isVisible

(

)

const [virtual]

Gets the visibility of the dialog if any.

This pure virtual function must be overloaded in inherited classes.

Returns:

The visibility of the dialog if any.

Implements IlvWindowsPrinterDCFactory.

virtual void IlvWindowsPrinterDCDialogFactory::resetSettings

(

)

[virtual]

Resets the printer settings used to create the printer DC.

This pure virtual function must be overloaded in inherited classes.

Implements IlvWindowsPrinterDCFactory.

virtual void IlvWindowsPrinterDCDialogFactory::setFirstLastPages	(	IlUShort	firstPage,
		IlUShort	lastPage
	)			[virtual]

Sets the value of the first and last pages to be printed.

Parameters:

	firstPage	The value (counted from 1) of the first page to be printed.
	lastPage	The value (counted from 1) of the last page to be printed.

Implements IlvWindowsPrinterDCFactory.

virtual void IlvWindowsPrinterDCDialogFactory::setMinMaxPageRange	(	IlUShort	minPage,
		IlUShort	maxPage
	)			[virtual]

Sets the extremum values for the page range.

If the values are equal, then the page range is not used by the dialog.

Parameters:

	minPage	The minimum value for the page range.
	maxPage	The maximum value for the page range.

Implements IlvWindowsPrinterDCFactory.

virtual void IlvWindowsPrinterDCDialogFactory::setOrientation	(	short	newOrientation,
		IlvDisplay &	display
	)			[virtual]

Sets the orientation of the paper for the current settings of the printer.

This pure virtual function must be overloaded in inherited classes.

The values are the same as the ones specified in the member dmOrientation of the Windows structure DEVMODE.

Parameters:

	newOrientation	The new orientation of the paper.
	display	A reference to the display.

Implements IlvWindowsPrinterDCFactory.

virtual void IlvWindowsPrinterDCDialogFactory::setPaperLength	(	short	length,
		IlvDisplay &	display
	)			[virtual]

Overrides the length of the paper.

If the value is 0, then the width is not overridden.

The value is specified in tenths of a millimeter.

Parameters:

	length	The length of the paper.
	display	A reference to the display.

Implements IlvWindowsPrinterDCFactory.

virtual void IlvWindowsPrinterDCDialogFactory::setPaperSize	(	short	paperSize,
		IlvDisplay &	display
	)			[virtual]

Sets the size of the paper.

The values are the same as the ones specified in the member dmPaperSize of the Windows structure DEVMODE.

Parameters:

	paperSize	The size of the paper.
	display	A reference to the display.

Implements IlvWindowsPrinterDCFactory.

virtual void IlvWindowsPrinterDCDialogFactory::setPaperWidth	(	short	width,
		IlvDisplay &	display
	)			[virtual]

Overrides the width of the paper.

The value is specified in tenths of a millimeter.

Parameters:

	width	The width of the paper.
	display	A reference to the display.

Implements IlvWindowsPrinterDCFactory.

void IlvWindowsPrinterDCDialogFactory::setTransientView

(

IlvSystemView

view

)

Sets the owner view of the dialog.

This is the owner view in Windows terminology.

Parameters:

view

The view for which the dialog is transient, or 0 if none.

virtual void IlvWindowsPrinterDCDialogFactory::setVisibility

(

IlBoolean

isVisible

)

[virtual]

Sets the visibility of the dialog if any.

This pure virtual function must be overloaded in inherited classes.

Parameters:

isVisible

The visibility of the dialog if any.

Implements IlvWindowsPrinterDCFactory.

virtual void IlvWindowsPrinterDCDialogFactory::usePageSettingDialog

(

IlBoolean

use

)

[virtual]

Sets an indication of whether a dialog that manages page numbers is used.

Parameters:

use

Sets a dialog that manages page numbers to be used when IlTrue, not to be used when IlFalse.

Implements IlvWindowsPrinterDCFactory.