MConverterUiObserver Class Reference

class MConverterUiObserver

Interface implemented by the client of a conversion operation to observe conversion progress.

CConverterBase2

Public Member Functions
voidMaxSteps(TInt, TInt)
HBufC *QueryPasswordL(const TDesC &)
IMPORT_C voidReserved1_Conv_Obs()
TInt Result(TInt, TInt)
Public Member Enumerations
enumTAction { ERetain, ERemove, ERepeat }
enumTResult { ESuccess, EPartialSuccess, EFailure }

Member Functions Documentation

MaxSteps(TInt, TInt)

voidMaxSteps(TIntaMax,
TIntaObject
)[pure virtual]

Gets the maximum number of steps that the conversion operation can take.

The conversion may complete in less than this number of steps (for example if an error occurs or the action is cancelled).

Each step is a call to CConverterBase2::DoConvert(), although during synchronous conversions this is transparent to the client code.

Parameters

TInt aMaxMaximum number of conversion steps.
TInt aObjectIndex that identifies an embedded object when one is being converted.

QueryPasswordL(const TDesC &)

HBufC *QueryPasswordL(const TDesC &aClue)[pure virtual]

Queries the client for a password in order to access the data.

The password entered.

Parameters

const TDesC & aClueData with a meaning that is specific to each converter: it could for example indicate where the password is stored.

Reserved1_Conv_Obs()

IMPORT_C voidReserved1_Conv_Obs()[virtual]

Result(TInt, TInt)

TInt Result(TIntaResult,
TIntaObject
)[pure virtual]

Alerts the client to an error in conversion.

A TAction value that indicates what action the converter should take.

Parameters

TInt aResultA TResult value indicating the conversion state.
TInt aObjectIndex that identifies an embedded object when one is being converted.

Member Enumerations Documentation

Enum TAction

Describes the actions that the converter should take.

Enumerators

ERetain

Keep already converted data.

ERemove

Delete converted data.

ERepeat

Reconvert data.

Enum TResult

Describes the result of a conversion operation.

Enumerators

ESuccess

Conversion succeeded.

EPartialSuccess

Conversion partially succeeded.

EFailure

Conversion failed.