Original Symbian headers
Selected EUSER, Window Server, networking, graphics and device declarations
Loading...
Searching...
No Matches
CPrinterDriver Class Reference

Provides access to a store containing printer specification data. More...

#include <gdi.h>

Inheritance diagram for CPrinterDriver:
CBase

Public Member Functions

IMPORT_C ~CPrinterDriver ()
 Destructor.
 
IMPORT_C void OpenPdrL (const TDesC &aName)
 Opens the specified printer specification data store.
 
IMPORT_C void Close ()
 Closes the printer specification data store and frees resources.
 
IMPORT_C TInt NumModels () const
 Gets the number of printer models defined by the printer specification.
 
IMPORT_C TPrinterModelEntry Model (TInt aNum) const
 Gets the specified printer model.
 
CPrinterDevice * PrinterDevice ()
 Gets the associated graphics printer device.
 
IMPORT_C CPrinterDevice * CreatePrinterDeviceL (TUid aModelUid)
 Creates the physical graphics device to be used for printing.
 
IMPORT_C CPrinterDriverUI * CreatePrinterDriverUIL ()
 Constructs a printer specific user interface.
 
- Public Member Functions inherited from CBase
 CBase ()
 Default constructor.
 
virtual IMPORT_C ~CBase ()
 Virtual destructor.
 
TAny * operator new (TUint aSize, TAny *aBase) __NO_THROW
 Initialises the object to binary zeroes.
 
TAny * operator new (TUint aSize) __NO_THROW
 Allocates the object from the heap and then initialises its contents to binary zeroes.
 
TAny * operator new (TUint aSize, TLeave)
 Allocates the object from the heap and then initialises its contents to binary zeroes.
 
TAny * operator new (TUint aSize, TUint aExtraSize) __NO_THROW
 Allocates the object from the heap and then initialises its contents to binary zeroes.
 
TAny * operator new (TUint aSize, TLeave, TUint aExtraSize)
 Allocates the object from the heap and then initialises its contents to binary zeroes.
 

Static Public Member Functions

static IMPORT_C CPrinterDriver * NewL ()
 Constructs, and returns a pointer to a new instance for accessing a printer specification data store.
 
- Static Public Member Functions inherited from CBase
static IMPORT_C void Delete (CBase *aPtr)
 Deletes the specified object.
 

Additional Inherited Members

- Protected Member Functions inherited from CBase
virtual IMPORT_C TInt Extension_ (TUint aExtensionId, TAny *&a0, TAny *a1)
 Extension function.
 

Detailed Description

Provides access to a store containing printer specification data.

Printer specification data is held as a direct file store, and usually has a .pdr file type.

A printer driver is implemented as two files: a PDR file containing the printer specification data and a PDL file containing the code to link the printer with the graphics printing system.

The printer specification data is generated by compiling a text file (a .pd file type) using the pdrtran tool. Printer specification data defines:

the name of the associated PDL

a list of one or more models supported by this driver, identified by name and UID

device information such as the size of the device, typeface information for each model, including which typefaces are supported, the heights available in each typeface and the width of each character in a font.

See also
CPrinterDriverUI
API status
Published to all clients. Released API.

Definition at line 4212 of file gdi.h.

Constructor & Destructor Documentation

◆ ~CPrinterDriver()

IMPORT_C CPrinterDriver::~CPrinterDriver ( )

Destructor.

It frees all resources owned by the object, prior to its destruction. In particular, it closes the printer specification data store and any open session with the file server.

(generated from Symbian Developer Library)

Member Function Documentation

◆ Close()

IMPORT_C void CPrinterDriver::Close ( )

Closes the printer specification data store and frees resources.

An open session with the file server remains open.

(generated from Symbian Developer Library)

◆ CreatePrinterDeviceL()

IMPORT_C CPrinterDevice * CPrinterDriver::CreatePrinterDeviceL ( TUid  aModelUid)

Creates the physical graphics device to be used for printing.

Parameters
aModelUidThe UID of a specific model which is defined in the printer specification data.

(generated from Symbian Developer Library)

◆ CreatePrinterDriverUIL()

IMPORT_C CPrinterDriverUI * CPrinterDriver::CreatePrinterDriverUIL ( )

Constructs a printer specific user interface.

The user interface object is optional, but if it exists, it is implemented as part of a UDL (i.e. a UI DLL).

(generated from Symbian Developer Library)

◆ Model()

IMPORT_C TPrinterModelEntry CPrinterDriver::Model ( TInt  aNum) const

Gets the specified printer model.

Parameters
aNumAn index into the list of printer models defined in the printer specification data.

(generated from Symbian Developer Library)

◆ NewL()

static IMPORT_C CPrinterDriver * CPrinterDriver::NewL ( )
static

Constructs, and returns a pointer to a new instance for accessing a printer specification data store.

(generated from Symbian Developer Library)

◆ NumModels()

IMPORT_C TInt CPrinterDriver::NumModels ( ) const

Gets the number of printer models defined by the printer specification.

(generated from Symbian Developer Library)

◆ OpenPdrL()

IMPORT_C void CPrinterDriver::OpenPdrL ( const TDesC &  aName)

Opens the specified printer specification data store.

(generated from Symbian Developer Library)

◆ PrinterDevice()

CPrinterDevice * CPrinterDriver::PrinterDevice ( )
inline

Gets the associated graphics printer device.

Returns
The physical graphics device used for printing.

Definition at line 4225 of file gdi.h.


The documentation for this class was generated from the following files: