|
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-3A498F20-5953-483D-951F-496D063A337E" 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 switch OFF the specified |
|
15 target light. Multiple light targets can be specified by using bitwise-or. </p><p>The |
|
16 following code snippet demonstrates how to switch OFF lights for infinite |
|
17 duration for multiple targets (Lights are switched OFF with fade-out): </p><codeblock xml:space="preserve">iLight->LightOffL( CHWRMExtendedLight::EPrimaryDisplay | CHWRMExtendedLight::EPrimaryKeyboard );</codeblock><p>The following code snippet demonstrates how to switch OFF lights for the |
|
18 specified duration for one target (Lights are switched OFF with fade-out): </p><codeblock xml:space="preserve">// aDuration = 5000 milliseconds |
|
19 light->LightOffL( CHWRMExtendedLight::ESecondaryDisplay, 5000 );</codeblock><p>After |
|
20 the duration expires, if there are no previous infinite time duration call |
|
21 in this session, the light state for target is changed to whatever state was |
|
22 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 lights OFF for the specified duration for one target (fade-out is also |
|
25 controlled): </p><codeblock xml:space="preserve">// aDuration = 5000 milliseconds |
|
26 // aFadeOut = EFalse means that lights turn off instantly and fade-out is not used, |
|
27 // ETrue means that lights smoothly fade-out. |
|
28 light->LightOnL( CHWRMExtendedLight::ESecondaryDisplay, 5000, EFalse );</codeblock><note> All |
|
29 devices do not support fade-out. In such scenarios where fade-out is not supported, |
|
30 the device behaves in its default state.</note></context> |
|
31 </taskbody></task> |