CConverterBase Class Reference

class CConverterBase : public CBase

For Ecom Style Converters i.e.,for v9.1 and above CConverterBase2 should be used.

Polymorphic interface for converters from one data format to another.

Clients use this interface to access data converters. The implementator of a data converter derives a class from this in which to implement the appropriate conversion functionality.

The interface offers conversions between files, and between objects that support the stream interfaces, e.g. stream stores.

There are two flavours of conversion methods:

the synchronous interfaces, ConvertL() and ConvertObjectL(), which perform the specified conversion and then return

the asynchronous interfaces, ConvertAL() and ConvertObjectAL(), which initialise the converter object, and allow the client code to call DoConvertL() a number of times until the conversion is complete or abandoned.

CConverterBase2

Inherits from

Member Functions Documentation

CancelConvert()

IMPORT_C voidCancelConvert()[virtual]

Capabilities()

IMPORT_C TIntCapabilities()[virtual]

ConvertAL(const TFileName &, const TFileName &, MConverterUiObserver *)

IMPORT_C voidConvertAL(const TFileName &aSourceFile,
const TFileName &aTargetFile,
MConverterUiObserver *aObserver = NULL
)[virtual]

Parameters

const TFileName & aSourceFile
const TFileName & aTargetFile
MConverterUiObserver * aObserver = NULL

ConvertL(const TFileName &, const TFileName &, MConverterUiObserver *)

IMPORT_C voidConvertL(const TFileName &aSourceFile,
const TFileName &aTargetFile,
MConverterUiObserver *aObserver = NULL
)[virtual]

Parameters

const TFileName & aSourceFile
const TFileName & aTargetFile
MConverterUiObserver * aObserver = NULL

ConvertObjectAL(RReadStream &, RWriteStream &, MConverterUiObserver *)

IMPORT_C voidConvertObjectAL(RReadStream &aReadStream,
RWriteStream &aWriteStream,
MConverterUiObserver *aObserver = NULL
)[virtual]

Parameters

RReadStream & aReadStream
RWriteStream & aWriteStream
MConverterUiObserver * aObserver = NULL

ConvertObjectL(RReadStream &, RWriteStream &, MConverterUiObserver *)

IMPORT_C voidConvertObjectL(RReadStream &aReadStream,
RWriteStream &aWriteStream,
MConverterUiObserver *aObserver = NULL
)[virtual]

Parameters

RReadStream & aReadStream
RWriteStream & aWriteStream
MConverterUiObserver * aObserver = NULL

DoConvertL()

IMPORT_C TBoolDoConvertL()[virtual]

EmbeddedObjectL(TDataType &)

IMPORT_C CConverterBase *EmbeddedObjectL(TDataType &aType)[virtual]

Parameters

TDataType & aType

ExtendedInterfaceL(TUid, CBase *&)

IMPORT_C voidExtendedInterfaceL(TUidaInterfaceUid,
CBase *&aInterface
)[virtual]

Parameters

TUid aInterfaceUid
CBase *& aInterface

GetEmbeddedFileName(TFileName &)

IMPORT_C TBoolGetEmbeddedFileName(TFileName &aFileName)[virtual]

Parameters

TFileName & aFileName

Uid()

TUid Uid()[pure virtual]

Gets the converter's UID.

Converter's UID

Member Enumerations Documentation

Enum TCapability

Bitmask values that describe the capabilities of the converter.

Enumerators

EConvertsFiles = 0x01

The converter can convert files.

EConvertsObjects = 0x02

The converter can convert stream objects.

EConvertsExtract = 0x04

The converter can extract embedded objects.