Views
Foundation Package API Reference Guide
Product Documentation:
Views Documentation Home
List of all members | Public Member Functions | Protected Member Functions
IlvWindowsPrinterDCDialogFactory Class Reference

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

#include <ilviews/windows/dump.h>

Inheritance diagram for IlvWindowsPrinterDCDialogFactory:
IlvWindowsPrinterDCFactory

Public Member Functions

 IlvWindowsPrinterDCDialogFactory ()
 Initializes a new IlvWindowsPrinterDCDialogFactory instance.
 
virtual IlBoolean getFirstLastPages (IlUShort &, IlUShort &) const
 Gets the first and last number of the pages to be printed. More...
 
virtual HDC getHDC () const
 Gets the printer HDC. More...
 
virtual IlBoolean getMinMaxPageRange (IlUShort &, IlUShort &) const
 Gets the extremum values for the page range. More...
 
virtual short getOrientation () const
 Gets the orientation of the paper for the current settings of the printer. More...
 
virtual short getPaperLength () const
 Gets the overridden length of the paper. More...
 
virtual short getPaperSize () const
 Gets the size of the paper. More...
 
virtual short getPaperWidth () const
 Gets the overridden width of the paper. More...
 
virtual IlBoolean hasPageSettingDialog () const
 Returns an indication of whether a dialog that manages page numbers is used. More...
 
virtual IlBoolean initializeSettings ()
 Initializes the printer settings used to create the DC. More...
 
virtual IlBoolean isVisible () const
 Gets the visibility of the dialog, if any. More...
 
virtual void resetSettings ()
 Resets the printer settings used to create the printer DC. More...
 
virtual void setFirstLastPages (IlUShort, IlUShort)
 Sets the value of the first and last pages to be printed. More...
 
virtual void setMinMaxPageRange (IlUShort, IlUShort)
 Sets the extremum values for the page range. More...
 
virtual void setOrientation (short newOrientation, IlvDisplay &)
 Sets the orientation of the paper for the current settings of the printer. More...
 
virtual void setPaperLength (short length, IlvDisplay &)
 Overrides the length of the paper. More...
 
virtual void setPaperSize (short paperSize, IlvDisplay &)
 Sets the size of the paper. More...
 
virtual void setPaperWidth (short width, IlvDisplay &)
 Overrides the width of the paper. More...
 
void setTransientView (IlvSystemView view)
 Sets the owner view of the dialog. More...
 
virtual void setVisibility (IlBoolean)
 Sets the visibility of the dialog, if any. More...
 
virtual void usePageSettingDialog (IlBoolean)
 Sets an indication of whether a dialog that manages page numbers is used. More...
 
- Public Member Functions inherited from IlvWindowsPrinterDCFactory
 IlvWindowsPrinterDCFactory ()
 Initializes a new IlvWindowsPrinterDCFactory instance.
 
IlBoolean isInitialized () const
 Indicates whether the settings were initialized. More...
 
void setInitialized () const
 Sets the initialization flag to IlTrue.
 
void unsetInitialized () const
 Sets the initialization flag to IlFalse.
 

Protected Member Functions

PRINTDLG & getPrintDLG () const
 Returns a reference to the PRINTDLG structure used by the dialog. More...
 

Detailed Description

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

Library: winviews

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

See also
IlvWindowsPrinter::setPrinterDCFactory(), IlvWindowsDevice::setPrinterDCFactory()

Member Function Documentation

◆ getFirstLastPages()

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

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

Parameters
firstPageSet on return to the number of the first page to be printed (starting at 1).
lastPageSet on return to the number of the last page to be printed (starting at 1).
Returns
Indicates, if IlTrue, that the values were updated in the dialog.

Implements IlvWindowsPrinterDCFactory.

◆ getHDC()

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.

◆ getMinMaxPageRange()

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
minPageSet on return to the minimum value.
maxPageSet on return to the maximum value.
Returns
Indicates, when IlTrue, that the values are used by the dialog.

Implements IlvWindowsPrinterDCFactory.

◆ getOrientation()

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.

◆ getPaperLength()

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.

◆ getPaperSize()

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.

◆ getPaperWidth()

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.

◆ getPrintDLG()

PRINTDLG& IlvWindowsPrinterDCDialogFactory::getPrintDLG ( ) const
protected

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.

◆ hasPageSettingDialog()

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

Implements IlvWindowsPrinterDCFactory.

◆ initializeSettings()

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.

◆ isVisible()

virtual IlBoolean IlvWindowsPrinterDCDialogFactory::isVisible ( ) const
virtual

Gets the visibility of the dialog, if any.

Returns
The visibility of the dialog, if any.

Implements IlvWindowsPrinterDCFactory.

◆ resetSettings()

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.

◆ setFirstLastPages()

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

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

Parameters
firstPageThe value (starting at 1) of the first page to be printed.
lastPageThe value (starting at 1) of the last page to be printed.

Implements IlvWindowsPrinterDCFactory.

◆ setMinMaxPageRange()

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
minPageThe minimum value for the page range.
maxPageThe maximum value for the page range.

Implements IlvWindowsPrinterDCFactory.

◆ setOrientation()

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
newOrientationThe new orientation of the paper.
displayA reference to the display.

Implements IlvWindowsPrinterDCFactory.

◆ setPaperLength()

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
lengthThe length of the paper.
displayA reference to the display.

Implements IlvWindowsPrinterDCFactory.

◆ setPaperSize()

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
paperSizeThe size of the paper.
displayA reference to the display.

Implements IlvWindowsPrinterDCFactory.

◆ setPaperWidth()

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
widthThe width of the paper.
displayA reference to the display.

Implements IlvWindowsPrinterDCFactory.

◆ setTransientView()

void IlvWindowsPrinterDCDialogFactory::setTransientView ( IlvSystemView  view)

Sets the owner view of the dialog.

This is the owner view in Windows terminology.

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

◆ setVisibility()

virtual void IlvWindowsPrinterDCDialogFactory::setVisibility ( IlBoolean  isVisible)
virtual

Sets the visibility of the dialog, if any.

Parameters
isVisibleThe visibility of the dialog, if any.

Implements IlvWindowsPrinterDCFactory.

◆ usePageSettingDialog()

virtual void IlvWindowsPrinterDCDialogFactory::usePageSettingDialog ( IlBoolean  use)
virtual

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

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

Implements IlvWindowsPrinterDCFactory.