Special type of TECAMEvent class used to retrieve some extra information from particular events received. More...
#include <ecam.h>
Public Member Functions | |
| IMPORT_C | TECAMEvent2 (TUid aEventType, TInt aErrorCode, TInt aParam) |
| Constructor. | |
| IMPORT_C const TUid & | EventClassUsed () const |
| Gives the uid representing this version of TECAMEvent base class. | |
 Public Member Functions inherited from TECAMEvent | |
| IMPORT_C | TECAMEvent (TUid aEventType, TInt aErrorCode) |
| Constructor. | |
| IMPORT_C | TECAMEvent () |
| Default constructor. | |
Static Public Member Functions | |
| static IMPORT_C TBool | IsEventEncapsulationValid (const TECAMEvent &aECAMEvent) |
| 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. | |
Public Attributes | |
| TInt | iParam1 |
| iParam1 will be used to provide extra information if iParam is not sufficient. | |
| TInt | iParam |
| This signifies different things for different valid events. | |
| Public Attributes inherited from TECAMEvent | |
| TUid | iEventType |
| A UID to define the event type. | |
| TInt | iErrorCode |
| The error code associated with the event. | |
Detailed Description
Special type of TECAMEvent class used to retrieve some extra information from particular events received.
- API status
- Published to all clients. Released API.
Constructor & Destructor Documentation
◆ TECAMEvent2()
| IMPORT_C TECAMEvent2::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
-
aEventType A UID to define the type of event. aErrorCode The error code associated with the event. aParam This signifies different things for different valid events.
(generated from Symbian Developer Library)
Member Function Documentation
◆ EventClassUsed()
| IMPORT_C const TUid & TECAMEvent2::EventClassUsed | ( | ) | const |
Gives the uid representing this version of TECAMEvent base class.
(generated from Symbian Developer Library)
◆ IsEventEncapsulationValid()
|
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
-
aECAMEvent TECAMEvent class reference providing details of a particular event
(generated from Symbian Developer Library)
Member Data Documentation
◆ iParam
| TInt TECAMEvent2::iParam |
◆ iParam1
| TInt TECAMEvent2::iParam1 |
The documentation for this class was generated from the following files:
