All Frameworks  Class Hierarchy  This Framework  Previous  Next  Indexes

PrintBase Class CATPrinterDevice

System.IUnknown
  |
  +---System.IDispatch
    |
    +---System.CATBaseUnknown
      |
      +---PrintBase.CATPrintDevice
        |
        +---PrintBase.CATPrintFileDevice
          |
          +---CATPrinterDevice
 

Usage: you must use this class as is. You should never derive it.


public class CATPrinterDevice

Class to create a printer device.

Role: This class allows to create a device based on a printer, or for printing to a file instead sending data to the printer.

See also:
CATPrinter, CATPrintFileDevice


Constructor and Destructor Index


o CATPrinterDevice(CATPrinter*)
Constructs a CATPrinterDevice from a given printer.
o CATPrinterDevice(CATPrinter*,CATUnicodeString&)
Constructs a CATPrinterDevice for printing to a file.
o ~CATPrinterDevice()

Method Index


o Begin(CATPrintParameters&)
Initializes the printer device with given parameters.
o End(void)
Terminates the using of the printer device.
o GetCopies(void)
Returns the number of copies.
o GetFileName(void)
Returns the file name of the printer device.
o GetTargetPrinter(void)
Returns the target printer.
o SetCopies(int)
Sets the number of copies.
o SetDocumentName(CATUnicodeString&)
Sets the document name.
o SetFileName(CATUnicodeString&)
Sets the file name of the printer device.

Constructor and Destructor


o CATPrinterDevice
public CATPrinterDevice( const CATPrinter* iPrinter= NULL )
Constructs a CATPrinterDevice from a given printer.
Parameters:
iPrinter
The device printer.
o CATPrinterDevice
public CATPrinterDevice( const CATPrinter* iPrinter,
const CATUnicodeString& iFileName)
Constructs a CATPrinterDevice for printing to a file.
Parameters:
iPrinter
The device printer.
iFileName
The file name where to print.
o ~CATPrinterDevice
public virtual ~CATPrinterDevice()

Methods


o Begin
public int Begin( const CATPrintParameters& iParameters)
Initializes the printer device with given parameters.
Parameters:
iParameters
The device parameters.
Returns:
Check the status of the device.
Legal values: 1 = OK, 0 = KO.
o End
public void End(void )
Terminates the using of the printer device.
o GetCopies
public int GetCopies(void )
Returns the number of copies.
Returns:
The number of copies.
o GetFileName
public const CATUnicodeString* GetFileName(void ) const
Returns the file name of the printer device.
Returns:
The file name of the printer device.
o GetTargetPrinter
public const CATPrinter* GetTargetPrinter(void ) const
Returns the target printer.
Returns:
The target printer.
o SetCopies
public void SetCopies(int iCopies)
Sets the number of copies.
Parameters:
iCopies
The number of copies.
o SetDocumentName
public void SetDocumentName( const CATUnicodeString& iDocName)
Sets the document name.
Parameters:
iDocName
The file name of the printer device.
o SetFileName
public void SetFileName( const CATUnicodeString& iFileName)
Sets the file name of the printer device.
Parameters:
iFileName
The file name of the printer device.

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

Copyright © 2003, Dassault Systèmes. All rights reserved.