Symbian Developer Library

SYMBIAN OS V6.1 EDITION FOR C++

[Index] [Glossary] [Previous] [Next]



Location: conarc.h
Link against: conarc.lib

Class MConverterUiObserver

MConverterUiObserver

Support

Supported from 6.0

Description

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

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

See also:


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 CConverterBase::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

[Top]


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

[Top]


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 is specific to each converter: it could for example indicate where the password is stored.

Return value

HBufC*

Password entered

[Top]


Enum TAction

TAction

Description

Describes actions that the converter should take.

ERetain

Keep already converted data.

ERemove

Delete converted data.

ERepeat

Reconvert data.

[Top]


Enum TResult

TResult

Description

Describes result of a conversion operation.

ESuccess

Conversion succeeded.

EPartialSuccess

Conversion partially succeeded.

EFailure

Conversion failed.