|
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-056736E0-3DF0-49FE-A44D-1A8E47FE45A0" xml:lang="en"><title>Switching |
|
13 OFF the lights</title><prolog><metadata><keywords/></metadata></prolog><taskbody> |
|
14 <context> <p>The<codeph> LightOffL()</codeph> method call switches OFF |
|
15 the specified target light. Multiple light targets can be specified by using |
|
16 bitwise-or.</p><p>The following code snippet demonstrates how to switch lights |
|
17 OFF for infinite duration for multiple targets. Lights are switched OFF with |
|
18 fade-out.</p><codeblock xml:space="preserve">iLight->LightOffL( CHWRMLight::EPrimaryDisplay | CHWRMLight::EPrimaryKeyboard );</codeblock><p>The |
|
19 following code snippet demonstrates how to switch OFF lights for the specified |
|
20 duration for one target (Lights are switched OFF with fade-out):</p><codeblock xml:space="preserve">// aDuration = 5000 milliseconds |
|
21 light->LightOffL( CHWRMLight::ESecondaryDisplay, 5000 );</codeblock><p>After |
|
22 the duration expires, if there has not been a previous infinite time duration |
|
23 call in this session, the light state for target is changed to whatever state |
|
24 was caused by the last infinite time duration call, or default state determined |
|
25 by inactivity timer.</p><p>The following code snippet demonstrates how to |
|
26 switch OFF lights for the specified duration for one target (fade-out is also |
|
27 controlled):</p><codeblock xml:space="preserve">// aDuration = 5000 milliseconds |
|
28 // aFadeOut = EFalse means that lights turn off instantly and fade-out is not used, |
|
29 // ETrue means that lights smoothly fade-out. |
|
30 light->LightOnL( CHWRMLight::ESecondaryDisplay, 5000, EFalse );</codeblock><note> All |
|
31 devices do not support fade-out. In such scenario, the device behaves in its |
|
32 default state.</note></context> |
|
33 </taskbody></task> |