|
1 <?xml version="1.0" encoding="utf-8"?> |
|
2 <!-- Copyright (c) 2007-2010 Nokia Corporation and/or its subsidiary(-ies) All rights reserved. --> |
|
3 <!-- This component and the accompanying materials are made available under the terms of the License |
|
4 "Eclipse Public License v1.0" which accompanies this distribution, |
|
5 and is available at the URL "http://www.eclipse.org/legal/epl-v10.html". --> |
|
6 <!-- Initial Contributors: |
|
7 Nokia Corporation - initial contribution. |
|
8 Contributors: |
|
9 --> |
|
10 <!DOCTYPE task |
|
11 PUBLIC "-//OASIS//DTD DITA Task//EN" "task.dtd"> |
|
12 <task id="GUID-4FE4B515-EE2B-47DB-BECE-E390E4EB2C3E" xml:lang="en"><title>Switching |
|
13 ON the lights</title><prolog><metadata><keywords/></metadata></prolog><taskbody> |
|
14 <context> <p>The LightOnL() method call switches ON the specified target |
|
15 light. Multiple light targets can be specified using bitwise-or.</p><p>The |
|
16 following code snippet demonstrates how to switch ON lights for <b>infinite</b> duration |
|
17 with default intensity for multiple targets (Lights are switched ON with fade-in):</p><codeblock xml:space="preserve">iLight->LightOnL( CHWRMLight::EPrimaryDisplay | CHWRMLight::EPrimaryKeyboard );</codeblock><p>The following code snippet demonstrates how to switch ON lights for the <b>specified</b> duration |
|
18 with default intensity for one target (Lights are switched ON with fade-in):</p><codeblock xml:space="preserve">//aDuration = 5000 milliseconds |
|
19 light->LightOnL( CHWRMLight::ESecondaryDisplay, 5000 );</codeblock><p>After |
|
20 the duration expires, if there has not been a previous infinite time duration |
|
21 call in this session, the light state for target is changed to whatever state |
|
22 was caused by the last infinite time duration call, or default state determined |
|
23 by inactivity timer.</p><p>The following code snippet demonstrates how to |
|
24 switch ON lights for the specified duration with specified intensity for one |
|
25 target (fade-in is also controlled):</p><codeblock xml:space="preserve">// aDuration = 5000 milliseconds |
|
26 // aIntensity = 50, intensity can be between KHWRMLightMinIntensity and KHWRMLightMaxIntensity, inclusive. |
|
27 // aFadeIn = EFalse means that lights will turn ON instantly and fade-in is not used, |
|
28 // ETrue would mean that lights would smoothly fade-in. |
|
29 light->LightOnL( CHWRMLight::ESecondaryDisplay, 5000, 50, EFalse );</codeblock><note> All |
|
30 devices do not support user-defined intensity or fade-in. In such scenarios, |
|
31 the device behaves in its default method.</note></context> |
|
32 </taskbody></task> |