Symbian
Symbian OS Library

SYMBIAN OS V9.3

[Index] [Spacer] [Previous] [Next]



Location: CONARC.H
Link against: conarc.lib

Class MConverterUiObserver

class MConverterUiObserver;

Description

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

Members

Defined in MConverterUiObserver:
EFailure, EPartialSuccess, ERemove, ERepeat, ERetain, ESuccess, MaxSteps(), QueryPasswordL(), Reserved1_Conv_Obs(), Result(), TAction, TResult

See also:


Member functions


MaxSteps()

virtual void MaxSteps(TInt aMax, TInt aObject)=0;

Description

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 aMax

Maximum number of conversion steps.

TInt aObject

Index that identifies an embedded object when one is being converted.


Result()

virtual TInt Result(TInt aResult, TInt aObject)=0;

Description

Alerts the client to an error in conversion.

Parameters

TInt aResult

A TResult value indicating the conversion state.

TInt aObject

Index that identifies an embedded object when one is being converted.

Return value

TInt

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


QueryPasswordL()

virtual HBufC *QueryPasswordL(const TDesC &aClue)=0;

Description

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

Parameters

const TDesC &aClue

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

Return value

HBufC *

The password entered.


Reserved1_Conv_Obs()

virtual IMPORT_C void Reserved1_Conv_Obs();

Description

[Top]


Member enumerations


Enum TResult

TResult

Description

Describes the result of a conversion operation.

ESuccess

Conversion succeeded.

EPartialSuccess

Conversion partially succeeded.

EFailure

Conversion failed.


Enum TAction

TAction

Description

Describes the actions that the converter should take.

ERetain

Keep already converted data.

ERemove

Delete converted data.

ERepeat

Reconvert data.