Class TECAMEvent2

class TECAMEvent2 : public TECAMEvent;

Description

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

Derivation

• TECAMEvent - General purpose class to describe an ECam event.

• TECAMEvent2 - Special type of TECAMEvent class used to retrieve some extra information from pa...

Members

Defined in TECAMEvent2:

• EventClassUsed()constGives the uid representing this version of TECAMEvent base class.
• IsEventEncapsulationValid(const TECAMEvent &)This method may be used by MCameraObserver2::HandleEvent(const TECAMEvent &)...
• TECAMEvent2(TUid,TInt,TInt)Constructor.
• iParamThis signifies different things for different valid events.
• iParam1iParam1 will be used to provide extra information if iParam is not sufficient. T...

Inherited from TECAMEvent:

• TECAMEvent(TUid,TInt)Constructor.
• iErrorCodeThe error code associated with the event.
• iEventTypeA UID to define the event type.

IMPORT_C TECAMEvent2(TUid aEventType, TInt aErrorCode, TInt aParam);

Description

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 aEventType A UID to define the type of event. TInt aErrorCode The error code associated with the event. TInt aParam This signifies different things for different valid events.

IMPORT_C static TBool IsEventEncapsulationValid(const TECAMEvent &aECAMEvent);

Description

This method may be used by MCameraObserver2::HandleEvent(const TECAMEvent &) 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(const TECAMEvent &) 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(const TECAMEvent &) 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 &aECAMEvent TECAMEvent class reference providing details of a particular event

Return value

TBool ETrue : This implies that the received event is recognized and belongs to this class. MCameraObserver2::HandleEvent(const TECAMEvent &) implementation may type-cast the aECAMEvent to TECAMEvent2 and proceed. EFalse : This is not an error condition. This implies that the event does not belong to this class. If event is a known event, this may belong to the base class or to some other version of base class. MCameraObserver2::HandleEvent(const TECAMEvent &) implementation may call any other such methods existing for different derived versions of TECAMEvent base class untill ETrue is retrieved. If EFalse is retrieved in each of such methods, implementation may type-cast the aECAMEvent to the base class and proceed further to recognise the event. This implies that:- 1) the given event is unrecognised and belong to base class or any derived class or an unrecognised derived class. 2) the given event is recognised and belong to base class.

IMPORT_C const TUid& EventClassUsed() const;

Description

Gives the uid representing this version of TECAMEvent base class.

Return value

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

TInt iParam1;

Description

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 iParam;

Description

This signifies different things for different valid events.

Future events may also use this class member variable.