Collapse all Symbian^3 Application Developer Library

TECAMEvent2 Class Reference

class TECAMEvent2 : public TECAMEvent

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

Inherits from

TECAMEvent2
- TECAMEvent

Public Member Functions
	TECAMEvent2 ( TUid , TInt , TInt )
IMPORT_C const TUid &	EventClassUsed ()
IMPORT_C TBool	IsEventEncapsulationValid (const TECAMEvent &)

Inherited Functions
	TECAMEvent::TECAMEvent()
	TECAMEvent::TECAMEvent(TUid,TInt)

Public Attributes
TInt	iParam
TInt	iParam1

Private Attributes
TUid	iEventClassUsed
TInt	iReserved2

Inherited Attributes
	TECAMEvent::iErrorCode
	TECAMEvent::iEventType

Constructor & Destructor Documentation

TECAMEvent2(TUid, TInt, TInt)

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

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.

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 TBool

IsEventEncapsulationValid

(

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 .