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