| class CHWRMExtendedLight : public CBase |
Base class of Extended Light Client API of HWRM
The HWRM Extended Light API provides the ability to control the device display light as well as the keyboard illumination.
Every new call of the extended light API method stops all ongoing light control orders. Light state after duration based orders expire is the state specified by the last non-duration based order.
The interface contains synchronous methods that will block the client application.
| Public Member Functions | |
|---|---|
| void | LightBlinkL(TInt) |
| void | LightBlinkL(TInt, TInt) |
| void | LightBlinkL(TInt, TInt, TInt, TInt, TInt) |
| void | LightOffL(TInt) |
| void | LightOffL(TInt, TInt) |
| void | LightOffL(TInt, TInt, TBool) |
| void | LightOnL(TInt) |
| void | LightOnL(TInt, TInt) |
| void | LightOnL(TInt, TInt, TInt, TBool) |
| TLightStatus | LightStatus(TInt) |
| IMPORT_C CHWRMExtendedLight * | NewL() |
| IMPORT_C CHWRMExtendedLight * | NewL(MHWRMExtendedLightObserver *) |
| IMPORT_C CHWRMExtendedLight * | NewL(TInt) |
| IMPORT_C CHWRMExtendedLight * | NewL(MHWRMExtendedLightObserver *, TInt) |
| IMPORT_C CHWRMExtendedLight * | NewLC() |
| IMPORT_C CHWRMExtendedLight * | NewLC(MHWRMExtendedLightObserver *) |
| void | ReleaseLight(TInt) |
| void | ReserveLightL(TInt) |
| void | ReserveLightL(TInt, TBool, TBool) |
| TInt | SupportedTargets() |
| void | LightBlinkL | ( | TInt | aTarget | ) | [pure virtual] |
The LightBlinkL method blinks the target light(s) of the device for infinite duration using default intensity.
| TInt aTarget | Defines which light should be controlled. Multiple lights can be specified with using bitwise-or. |
| void | LightBlinkL | ( | TInt | aTarget, |
| TInt | aDuration | |||
| ) | [pure virtual] | |||
The LightBlinkL method blinks the target light(s) of the device for specified duration using default intensity.
| TInt aTarget | Defines which light should be controlled. Multiple lights can be specified with using bitwise-or. |
| TInt aDuration | Duration of the time the light is set to blink measured in milliseconds. After the duration expires, the light state for target will be changed to whatever state was caused by the last infinite time duration call, or default state determined by inactivity timer, in case there has not been a previous infinite time duration call in this session. If the aTotalDuration time is KHWRMInfiniteDuration then it means an infinite value that has to be stopped by calling of any of the other light control methods. Duration can have maximum value of KHWRMLightMaxDuration. |
| void | LightBlinkL | ( | TInt | aTarget, |
| TInt | aDuration, | |||
| TInt | aOnDuration, | |||
| TInt | aOffDuration, | |||
| TInt | aIntensity | |||
| ) | [pure virtual] | |||
The LightBlinkL method blinks the target light(s) of the device for specified duration using specified intensity. On- and Off-cycle times of the blinking can also be controlled.
| TInt aTarget | Defines which light should be controlled. Multiple lights can be specified with using bitwise-or. |
| TInt aDuration | Duration of the time the light is set to blink measured in milliseconds. After the duration expires, the light state for target will be changed to whatever state was caused by the last infinite time duration call, or default state determined by inactivity timer, in case there has not been a previous infinite time duration call in this session. If the aTotalDuration time is KHWRMInfiniteDuration then it means an infinite value that has to be stopped by calling of any of the other light control methods. Duration can have maximum value of KHWRMLightMaxDuration. |
| TInt aOnDuration | Duration time, measured in milliseconds, of how long the Light is switched on in every Blink cycle. Duration can have maximum value of KHWRMLightMaxDuration. For device default cycle duration, use value KHWRMDefaultCycleTime. If either of aOnDuration or aOffDuration is KHWRMDefaultCycleTime, both must be KHWRMDefaultCycleTime. Some devices might not support variable blink cycle times, in which case default value will be substituted. |
| TInt aOffDuration | Duration time, measured in milliseconds, of how long the Light is switched off in every Blink cycle. Duration can have maximum value of KHWRMLightMaxDuration. For device default cycle duration, use value KHWRMDefaultCycleTime. If either of aOnDuration or aOffDuration is KHWRMDefaultCycleTime, both must be KHWRMDefaultCycleTime. Some devices might not support variable blink cycle times, in which case default value will be substituted. |
| TInt aIntensity | Intensity of the light. If aIntensity is KHWRMDefaultIntensity, device default intensity will be used. Note: All devices might not support user defined intensity, in which case device will behave in its default fashion. |
| void | LightOffL | ( | TInt | aTarget | ) | [pure virtual] |
The LightOffL method switches the device light off for the specified target for infinite duration. Lights will be switched off with fade-out.
| TInt aTarget | Defines which light should be controlled. Multiple lights can be specified with using bitwise-or. |
| void | LightOffL | ( | TInt | aTarget, |
| TInt | aDuration | |||
| ) | [pure virtual] | |||
The LightOffL method switches the device light off for the specified target for the specified duration time. Lights will be switched off with fade-out.
| TInt aTarget | Defines which light should be controlled. Multiple lights can be specified with using bitwise-or. |
| TInt aDuration | Duration of the time the light is switched off measured in milliseconds. After the duration expires, the light state for target will be changed to whatever state was caused by the last infinite time duration call, or default state determined by inactivity timer, in case there has not been a previous infinite time duration call in this session. If the aDuration time is KHWRMInfiniteDuration then it means an infinite value that has to be stopped by calling of any of the other light control methods. Duration can have maximum value of KHWRMLightMaxDuration. |
| void | LightOffL | ( | TInt | aTarget, |
| TInt | aDuration, | |||
| TBool | aFadeOut | |||
| ) | [pure virtual] | |||
The LightOffL method switches the device light off for the specified target for the specified duration time. Lights fade-out can also be controlled.
| TInt aTarget | Defines which light should be controlled. Multiple lights can be specified with using bitwise-or. |
| TInt aDuration | Duration of the time the light is switched off measured in milliseconds. After the duration expires, the light state for target will be changed to whatever state was caused by the last infinite time duration call, or default state determined by inactivity timer, in case there has not been a previous infinite time duration call in this session. If the aDuration time is KHWRMInfiniteDuration then it means an infinite value that has to be stopped by calling of any of the other light control methods. Duration can have maximum value of KHWRMLightMaxDuration. |
| TBool aFadeOut | If ETrue, lights will not turn off instantly but instead smoothly fade-out Note: All devices will not support fade-out, in which case device will behave in its default fashion. |
| void | LightOnL | ( | TInt | aTarget | ) | [pure virtual] |
The LightOnL method switches the specified target light on for infinite duration using default intensity. Lights will use fade-in.
| TInt aTarget | Defines which light should be controlled. Multiple lights can be specified with using bitwise-or. |
| void | LightOnL | ( | TInt | aTarget, |
| TInt | aDuration | |||
| ) | [pure virtual] | |||
The LightOnL method switches the specified target light on for the specified duration using default intensity. Lights will use fade-in.
| TInt aTarget | Defines which light should be controlled. Multiple lights can be specified with using bitwise-or. |
| TInt aDuration | Duration of the time the light is switched on measured in milliseconds. After the duration expires, the light state for target will be changed to whatever state was caused by the last infinite time duration call, or default state determined by inactivity timer, in case there has not been a previous infinite time duration call in this session. If the aDuration time is KHWRMInfiniteDuration then it means an infinite value that has to be stopped by calling of any of the other light control methods. Duration can have maximum value of KHWRMLightMaxDuration. |
| void | LightOnL | ( | TInt | aTarget, |
| TInt | aDuration, | |||
| TInt | aIntensity, | |||
| TBool | aFadeIn | |||
| ) | [pure virtual] | |||
The LightOnL method switches the specified target light on for the specified duration using specified intensity. Fade-in can also be controlled.
| TInt aTarget | Defines which light should be controlled. Multiple lights can be specified with using bitwise-or. |
| TInt aDuration | Duration of the time the light is switched on measured in milliseconds. After the duration expires, the light state for target will be changed to whatever state was caused by the last infinite time duration call, or default state determined by inactivity timer, in case there has not been a previous infinite time duration call in this session. If the aDuration time is KHWRMInfiniteDuration then it means an infinite value that has to be stopped by calling of any of the other light control methods. Duration can have maximum value of KHWRMLightMaxDuration. |
| TInt aIntensity | Intensity of the light. If aIntensity is KHWRMDefaultIntensity, device default intensity will be used. Note: All devices might not support user defined intensity, in which case device will behave in its default fashion. |
| TBool aFadeIn | If ETrue, lights will not turn on instantly but instead smoothly fade-in. Note: All devices will not support fade-in, in which case device will behave in its default fashion. |
| TLightStatus | LightStatus | ( | TInt | aTarget | ) | const [pure virtual] |
This method retrieves the current light status.
| TInt aTarget | Defines which light status is returned. This method only supports single target, as different targets might have different statuses. |
| IMPORT_C CHWRMExtendedLight * | NewL | ( | ) | [static] |
Two-phased constructor for implementation class.
| IMPORT_C CHWRMExtendedLight * | NewL | ( | MHWRMExtendedLightObserver * | aCallback | ) | [static] |
Two-phased constructor for implementation class. Use this method for creating a Light client with callbacks.
| MHWRMExtendedLightObserver * aCallback | Pointer to callback instance |
| IMPORT_C CHWRMExtendedLight * | NewL | ( | TInt | aPermittedTargets | ) | [static] |
Two-phased constructor for implementation class. On opening passes permitted targets.
| TInt aPermittedTargets | permitted targets. |
| IMPORT_C CHWRMExtendedLight * | NewL | ( | MHWRMExtendedLightObserver * | aCallback, |
| TInt | aPermittedTargets | |||
| ) | [static] | |||
Two-phased constructor for implementation class. Use this method for creating a Light client with callbacks. On opening passes permitted targets.
| MHWRMExtendedLightObserver * aCallback | Pointer to callback instance |
| TInt aPermittedTargets | permitted targets. |
| IMPORT_C CHWRMExtendedLight * | NewLC | ( | ) | [static] |
Two-phased constructor for implementation class. Leaves instance to cleanup stack.
| IMPORT_C CHWRMExtendedLight * | NewLC | ( | MHWRMExtendedLightObserver * | aCallback | ) | [static] |
Two-phased constructor for implementation class. Use this method for creating a Light client with callbacks. Leaves instance to cleanup stack.
| MHWRMExtendedLightObserver * aCallback | Pointer to callback instance |
| void | ReleaseLight | ( | TInt | aTarget | ) | [pure virtual] |
Releases light target if it was previously reserved for this client. If this client has not reserved any of the specified lights, this method does nothing. Any reserved light targets that are released and have no other suspended clients will be reset to default state, which is either lights on or lights off, depending on system inactivity time.
| TInt aTarget | Defines which light should be released. Multiple lights can be specified with using bitwise-or. |
| void | ReserveLightL | ( | TInt | aTarget | ) | [pure virtual] |
Reserves light target exclusively for this client. A higher priority client may cause lower priority client reservation to be temporarily suspended. Commands can still be issued in suspended state, but they will not be acted upon unless suspension is lifted within specified duration. The suspended client will not get any notification about suspension. If light target is already reserved by a higher or equal priority application, reserving will still succeeds, but reservation is immediately suspended.
Calling this method is equal to call ReserveLightL( aTarget, EFalse, EFalse), i.e. any previously frozen state will not be restored and CCoeEnv background/foreground status is always used to control further reservations.
| TInt aTarget | Defines which light should be reserved. Multiple lights can be specified with using bitwise-or. |
| void | ReserveLightL | ( | TInt | aTarget, |
| TBool | aRestoreState, | |||
| TBool | aForceNoCCoeEnv | |||
| ) | [pure virtual] | |||
Reserves light target exclusively for this client. A higher priority client may cause lower priority client reservation to be temporarily suspended. Commands can still be issued in suspended state, but they will not be acted upon unless suspension is lifted within specified duration. The suspended client will not get any notification about suspension. If light target is already reserved by a higher or equal priority application, reserving will still succeeds, but reservation is immediately suspended.
| TInt aTarget | Defines which light should be reserved. Multiple lights can be specified with using bitwise-or. |
| TBool aRestoreState | If ETrue, the state frozen on last release will be restored upon successful reservation. I.e. if light was blinking when it was released by this client the last time, it would start blinking again upon successful reservation. For the first reservation of each session this parameter is always considered EFalse regardless of what is supplied, as there is no previous frozen state to restore. |
| TBool aForceNoCCoeEnv | If EFalse, then reservation requires that this client is on the foreground at the time of reservation and light target will be automatically released and re-reserved based on background/foreground status of the this client. This also implies that CCoeEnv::Static() != NULL is required. If ETrue, the client will not require CCoeEnv to be present nor does it automatically reserve/release light by depending on foreground/background status of the client. Only trusted clients are allowed to set this flag to ETrue. Client is considered trusted if it has nonstandard priority defined in the lights policy. |
| TInt | SupportedTargets | ( | ) | const [pure virtual] |
This method retrieves the supported light targets of the device. Any attempt to use or reserve unsupported targets will fail with KErrNotSupported.
Possible light states that can be get for the different light targets
| ELightStatusUnknown = 0 |
For debugging/development and signaling an error conditions |
| ELightOn |
Light state switch to light on |
| ELightOff |
Light state switch to light off |
| ELightBlink |
Light state switch to light blinking |
Possible light targets. Targets can be used as bitmask. Some common masks are provided as enum.
Note that all targets are not supported by all devices. Attempting to use unsupported target will result in KErrNotSupported.
At least one target must be defined.
| ENoTarget = 0x0 |
No target. Not a valid target value, used only for error checking. |
| EPrimaryDisplay = 0x1 |
Primary display of the device. |
| EPrimaryKeyboard = 0x2 |
Primary keyboard of the device. |
| EPrimaryDisplayAndKeyboard = 0x3 |
Both primary display and the primary keyboard of the device. |
| ESecondaryDisplay = 0x4 |
Secondary display of the device. |
| ESecondaryKeyboard = 0x8 |
Secondary keyboard of the device. |
| ESecondaryDisplayAndKeyboard = 0xC |
Both secondary display and the secondary keyboard of the device. |
| ECustomTarget1 = 0x10 |
Device specific custom target 1. |
| ECustomTarget2 = 0x20 |
Device specific custom target 2. |
| ECustomTarget3 = 0x40 |
Device specific custom target 3. |
| ECustomTarget4 = 0x80 |
Device specific custom target 4. |
| ECustomTarget5 = 0x100 |
Device specific custom target 5. |
| ECustomTarget6 = 0x200 |
Device specific custom target 6. |
| ECustomTarget7 = 0x400 |
Device specific custom target 7. |
| ECustomTarget8 = 0x800 |
Device specific custom target 8. |
| ECustomTarget9 = 0x1000 |
Device specific custom target 9. |
| ECustomTarget10 = 0x2000 |
Device specific custom target 10. |
| ECustomTarget11 = 0x4000 |
Device specific custom target 11. |
| ECustomTarget12 = 0x8000 |
Device specific custom target 12. |
| ECustomTarget13 = 0x10000 |
Device specific custom target 13. |
| ECustomTarget14 = 0x20000 |
Device specific custom target 14. |
| ECustomTarget15 = 0x40000 |
Device specific custom target 15. |
| ECustomTarget16 = 0x80000 |
Device specific custom target 16. |
| ECustomTarget17 = 0x100000 |
Device specific custom target 17. |
| ECustomTarget18 = 0x200000 |
Device specific custom target 18. |
| ECustomTarget19 = 0x400000 |
Device specific custom target 19. |
| ECustomTarget20 = 0x800000 |
Device specific custom target 20. |
| ECustomTarget21 = 0x1000000 |
Device specific custom target 21. |
| ECustomTarget22 = 0x2000000 |
Device specific custom target 22. |
| ECustomTarget23 = 0x4000000 |
Device specific custom target 23. |
| ECustomTarget24 = 0x8000000 |
Device specific custom target 24. |
| ECustomTarget25 = 0x10000000 |
Device specific custom target 25. |
| ECustomTarget26 = 0x20000000 |
Device specific custom target 26. |
| ECustomTarget27 = 0x40000000 |
Device specific custom target 27. |
| ESystemTarget = 0x80000000 |
Special target used to control all currently available system lights. System lights normally include all displays and keyboards, but not custom lights. This is however device dependant. A target mask including this target is always changed to a device state specific target mask. Note that the system target with any other target is not supported. This target is always supported but it is never included in supported targets mask. |
Copyright ©2010 Nokia Corporation and/or its subsidiary(-ies).
All rights
reserved. Unless otherwise stated, these materials are provided under the terms of the Eclipse Public License
v1.0.