TECAMEvent2 Class Reference

class TECAMEvent2 : public TECAMEvent

Special type of TECAMEvent class used to retrieve some extra information from particular events received

Inherits from

Constructor & Destructor Documentation

TECAMEvent2(TUid, TInt, TInt)

IMPORT_CTECAMEvent2(TUidaEventType,
TIntaErrorCode,
TIntaParam
)

Constructor.

For example: For KUidECamEventCIPSetColorSwapEntry; KUidECamEventCIPRemoveColorSwapEntry; KUidECamEventCIPSetColorAccentEntry and KUidECamEventCIPRemoveColorAccentEntry, aParam represents color entry.

For KUidECamEventCameraSettingPreCaptureWarning, aParam represents bit field describing all PreCaptureWarnings currently issued.

Future events may also use this class.

Parameters

TUid aEventTypeA UID to define the type of event.
TInt aErrorCodeThe error code associated with the event.
TInt aParamThis signifies different things for different valid events.

Member Functions Documentation

EventClassUsed()

IMPORT_C const TUid &EventClassUsed()const

Gives the uid representing this version of TECAMEvent base class.

IsEventEncapsulationValid(const TECAMEvent &)

IMPORT_C TBoolIsEventEncapsulationValid(const TECAMEvent &aECAMEvent)[static]

This method may be used by MCameraObserver2::HandleEvent to know whether a particular event received has been encapsulated in a correct version of TECAMEvent base class. Indirectly, its provided implementation also specifies different events which are supposed to use a specific version of TECAMEvent base class. This static method will be provided per derived version of TECAMEvent base class. So, MCameraObserver2::HandleEvent implementation may consist of 2 parts: 1) Recognize the class which encapsulated the event(aECAMEvent) and type-cast to that class. 2) Recognize the event.

Note : MCameraObserver2::HandleEvent should ignore unrecognised events and unrecognized version of TECAMEvent base class. Unless clearly stated to use a particular derived version of TECAMEvent base class, events should use class TECAMEvent.

Parameters

const TECAMEvent & aECAMEventTECAMEvent class reference providing details of a particular event

Member Data Documentation

TUid iEventClassUsed

TUid iEventClassUsed[private]

Uid representing this version of TECAMEvent base class. Uid used is KUidECamEventClass2

TInt iParam

TInt iParam

This signifies different things for different valid events.

Future events may also use this class member variable.

TInt iParam1

TInt iParam1

iParam1 will be used to provide extra information if iParam is not sufficient. This signifies different things for different valid events.

Future events may also use this class member variable.

TInt iReserved2

TInt iReserved2[private]

Reserved for future TInt iReserved1; -> Made Public TInt iParam1 Reserved for future