Public View Protected View Private View

All Frameworks Class Hierarchy This Framework Indexes Previous Next

PrintBase Interface CATIPrinterManager

Usage: you can freely reimplement this interface.

interface CATIPrinterManager

Interface for external Printer Managers.

Method Index

o GetConfigurationDialog(CATDialog*,CATPrinter&,CATDlgWindow*&): Builds a configuration dialog for the given printer.
o GetExtendedOptionsDialog(CATDialog*,CATPrinter&,CATDlgWindow*&): Builds a dialog box for extended options (scheduling,.
o GetExtendedOptionsInfos(CATPrinter&,CATUnicodeString&): Gets information on extended options of the given printer.
o GetLastError(CATUnicodeString&): Gets the last error message.
o GetPrinterList(CATLISTP(CATPrinter)&): Gets the list of available printers .
o GetPrinterManagerDialog(CATDialog*,CATDlgWindow*&): Builds the printer manager dialog.
o GetPrinterStatus(CATPrinter&,CATUnicodeString&): Gets the status of the given printer.
o GetStatusDialog(CATDialog*,CATPrinter&,CATDlgWindow*&): Builds a status dialog for the given printer.
o IsExtendedOptionsSupport(void): Asks for extented options support (scheduling,.
o Print(CATPrinterDevice&,CATPrintParameters&,CATPrintImage*): Prints an image on a printer with given parameters.

Methods

o GetConfigurationDialog

public virtual GetConfigurationDialog(		`iParent`,
		`iPrinter`,
		`oDialog`)

Builds a configuration dialog for the given printer.

Parameters:

iParent: The parent dialog.
iPrinter: The printer for which the dialog is to be displayed.

Returns:

S_OK upon successful execution.

o GetExtendedOptionsDialog

public virtual GetExtendedOptionsDialog(		`iParent`,
		`iPrinter`,
		`oDialog`)

Builds a dialog box for extended options (scheduling,...) for the given printer.

Parameters:

iParent: The parent dialog.
iPrinter: The printer for which the dialog is to be displayed.
oDialog: A pointer to the dialog.

Returns:

S_OK upon successful execution.

o GetExtendedOptionsInfos

public virtual GetExtendedOptionsInfos(		`iPrinter`,
		`oStatus`)

Gets information on extended options of the given printer.

Parameters:

iPrinter: The printer for which the information is to be displayed.
oStatus: A string describing information about extended options (scheduling mode activated, ...).

Returns:

S_OK upon successful execution.

o GetLastError

public virtual GetLastError( oError)

Gets the last error message.

Parameters:

oError: The error messsage.

Returns:

S_OK upon successful execution.

o GetPrinterList

public virtual GetPrinterList( ioPrinterList)

Gets the list of available printers .

Parameters:

ioPrinterList: The list to be filled (initially empty).

Returns:

S_OK upon successful execution.

o GetPrinterManagerDialog

public virtual GetPrinterManagerDialog(		`iParent`,
		`oDialog`)

Builds the printer manager dialog.

Parameters:

iParent: The parent dialog.
oDialog: A pointer to the dialog.

Returns:

S_OK upon successful execution.

o GetPrinterStatus

public virtual GetPrinterStatus(		`iPrinter`,
		`oStatus`)

Gets the status of the given printer.

Parameters:

iPrinter: The printer for which the dialog is to be displayed.
oStatus: A string describing the status of the printer (Idle, Busy, etc.).

Returns:

S_OK upon successful execution.

o GetStatusDialog

public virtual GetStatusDialog(		`iParent`,
		`iPrinter`,
		`oDialog`)

Builds a status dialog for the given printer.

Parameters:

iParent: The parent dialog.
iPrinter: The printer for which the dialog is to be displayed.
oDialog: A pointer to the dialog.

Returns:

S_OK upon successful execution.

o IsExtendedOptionsSupport

public virtual IsExtendedOptionsSupport( )

Asks for extented options support (scheduling,...).

Returns:: S_OK if extented options support. E_FAIL if no extented options support.

o Print

public virtual Print(		`iDevice`,
	const	`iParameters`,
		`iImage`)

Prints an image on a printer with given parameters.

Parameters:

iDevice: The device on which the image is to be printed.
iParameters: The parameters applied to the printout.
iImage: The image to be printed.

Returns:

S_OK upon successful execution.

This object is included in the file: CATIPrinterManager.h
If needed, your Imakefile.mk should include the module: CATPrintBase