MConverterUiObserver Class Reference

#include <mw/conarc.h>

Link against: conarc.lib

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

Detailed Description

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

See also: CConverterBase2

Member Enumeration Documentation

Enum TAction

Describes the actions that the converter should take.

EnumeratorValueDescription
ERetain

Keep already converted data.

ERemove

Delete converted data.

ERepeat

Reconvert data.

Enum TResult

Describes the result of a conversion operation.

EnumeratorValueDescription
ESuccess

Conversion succeeded.

EPartialSuccess

Conversion partially succeeded.

EFailure

Conversion failed.

Member Function 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
aMaxMaximum number of conversion steps.
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.

Parameters
aClueData with a meaning that is specific to each converter: it could for example indicate where the password is stored.
Return Value
The password entered.

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.

Parameters
aResultA TResult value indicating the conversion state.
aObjectIndex that identifies an embedded object when one is being converted.
Return Value
A TAction value that indicates what action the converter should take.