Rogue Wave Views Foundation Package API Reference Guide |
Rogue Wave Views Documentation Home |
Windows-specific class to create a printer device context. More...
#include <ilviews/windows/dump.h>
Public Member Functions | |
IlvWindowsPrinterDCFactory () | |
The default constructor. | |
virtual | ~IlvWindowsPrinterDCFactory () |
The destructor. More... | |
virtual IlBoolean | getFirstLastPages (IlUShort &firstPage, IlUShort &lastPage) const =0 |
Gets the first and last number of the pages to be printed. More... | |
virtual HDC | getHDC () const =0 |
Gets the printer HDC . More... | |
virtual IlBoolean | getMinMaxPageRange (IlUShort &minPage, IlUShort &maxPage) const =0 |
Gets the extremum values for the page range. More... | |
virtual short | getOrientation () const =0 |
Gets the orientation of the paper for the current settings of the printer. More... | |
virtual short | getPaperLength () const =0 |
Gets the overridden length of the paper. More... | |
virtual short | getPaperSize () const =0 |
Gets the size of the paper. More... | |
virtual short | getPaperWidth () const =0 |
Gets the overridden width of the paper. More... | |
virtual IlBoolean | hasPageSettingDialog () const =0 |
Returns an indication of whether a dialog that manages page numbers is used. More... | |
virtual IlBoolean | initializeSettings ()=0 |
Initializes the printer settings used to create the DC. More... | |
IlBoolean | isInitialized () const |
Returns an indication of whether the settings were initialized. More... | |
virtual IlBoolean | isVisible () const =0 |
Gets the visibility of the dialog if any. More... | |
virtual void | resetSettings ()=0 |
Resets the printer settings used to create the printer DC. More... | |
virtual void | setFirstLastPages (IlUShort firstPage, IlUShort lastPage)=0 |
Sets the value of the first and last pages to be printed. More... | |
void | setInitialized () const |
Sets the initialization flag to IlTrue . | |
virtual void | setMinMaxPageRange (IlUShort minPage, IlUShort maxPage)=0 |
Sets the extremum values for the page range. More... | |
virtual void | setOrientation (short newOrientation, IlvDisplay &display)=0 |
Sets the orientation of the paper for the current settings of the printer. More... | |
virtual void | setPaperLength (short length, IlvDisplay &display)=0 |
Overrides the length of the paper. More... | |
virtual void | setPaperSize (short paperSize, IlvDisplay &display)=0 |
Sets the size of the paper. More... | |
virtual void | setPaperWidth (short width, IlvDisplay &display)=0 |
Overrides the width of the paper. More... | |
virtual void | setVisibility (IlBoolean isVisible)=0 |
Sets the visibility of the dialog if any. More... | |
void | unsetInitialized () const |
Sets the initialization flag to IlFalse . | |
virtual void | usePageSettingDialog (IlBoolean use)=0 |
Sets an indication of whether a dialog that manages page numbers is used. More... | |
Windows-specific class to create a printer device context.
Library: xviews or winviews or mviews (mutually exclusive)
This class lets the user specify how to create the printer device context.
This class is abstract. The user can either use the provided implementation (IlvWindowsPrinterDCDialogFactory
) or implement it himself. An example showing how to implement it is located in the samples/foundation/printing directory.
|
virtual |
The destructor.
The destructor is virtual and likely to be overloaded in inherited classes.
|
pure 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.
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. |
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure 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.
0
when an error occurred, or a valid HDC
otherwise. Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure 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.
minPage | A reference to an IlUShort where the minimum value is stored. |
maxPage | A reference to an IlUShort where the maximum value is stored. |
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure 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
.
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure virtual |
Gets the overridden length of the paper.
The value is specified in tenths of a millimeter.
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure 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
.
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure virtual |
Gets the overridden width of the paper.
The value is specified in tenths of a millimeter.
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure virtual |
Returns an indication of whether a dialog that manages page numbers is used.
IlTrue
when a dialog that manages page numbers is used, IlFalse
else. Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure virtual |
Initializes the printer settings used to create the DC.
This pure virtual function must be overloaded in inherited classes.
IlFalse
when canceled, otherwise IlTrue
. Implemented in IlvWindowsPrinterDCDialogFactory.
IlBoolean IlvWindowsPrinterDCFactory::isInitialized | ( | ) | const |
Returns an indication of whether the settings were initialized.
|
pure virtual |
Gets the visibility of the dialog if any.
This pure virtual function must be overloaded in inherited classes.
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure virtual |
Resets the printer settings used to create the printer DC.
This pure virtual function must be overloaded in inherited classes.
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure virtual |
Sets the value of the first and last pages to be printed.
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. |
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure virtual |
Sets the extremum values for the page range.
If the values are equal, then the page range is not used by the dialog.
minPage | The minimum value for the page range. |
maxPage | The maximum value for the page range. |
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure 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
.
newOrientation | The new orientation of the paper. |
display | A reference to the display. |
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure 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.
length | The length of the paper. |
display | A reference to the display. |
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure 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
.
paperSize | The size of the paper. |
display | A reference to the display. |
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure virtual |
Overrides the width of the paper.
The value is specified in tenths of a millimeter.
width | The width of the paper. |
display | A reference to the display. |
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure virtual |
Sets the visibility of the dialog if any.
This pure virtual function must be overloaded in inherited classes.
isVisible | The visibility of the dialog if any. |
Implemented in IlvWindowsPrinterDCDialogFactory.
|
pure virtual |
Sets an indication of whether a dialog that manages page numbers is used.
use | Sets a dialog that manages page numbers to be used when IlTrue , not to be used when IlFalse . |
Implemented in IlvWindowsPrinterDCDialogFactory.
© Copyright 2016, 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.