Symbian3/SDK/Source/GUID-3715E8EE-FF0A-4344-90F1-1609D54C166B.dita
changeset 7 51a74ef9ed63
parent 0 89d6a7a84779
equal deleted inserted replaced
6:43e37759235e 7:51a74ef9ed63
       
     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-3715E8EE-FF0A-4344-90F1-1609D54C166B" xml:lang="en"><title>Blinking
       
    13 lights</title><prolog><metadata><keywords/></metadata></prolog><taskbody>
       
    14 <context>       <p>The <codeph>LightBlinkL()</codeph> method call makes the
       
    15 specified target light to blink. Multiple light targets can be specified by
       
    16 using bitwise-or.</p><p>The following code snippet demonstrates how to make
       
    17 lights blink for infinite duration with default intensity for multiple targets:</p><codeblock xml:space="preserve">iLight-&gt;LightBlinkL( CHWRMLight::EPrimaryDisplay | CHWRMLight::EPrimaryKeyboard );</codeblock><p>The following code snippet demonstrates how to make lights blink for the
       
    18 specified duration with default intensity for one target.</p><codeblock xml:space="preserve">// aDuration = 5000 milliseconds
       
    19 light-&gt;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
       
    25 one target (On-cycle and off-cycle times of the blinking can also be controlled):</p><codeblock xml:space="preserve">// aDuration = 5000 milliseconds
       
    26 // aOnDuration = 500 milliseconds
       
    27 // aOffDuration = 500 milliseconds
       
    28 // aIntensity = 30, intensity can be between KHWRMLightMinIntensity and KHWRMLightMaxIntensity, inclusive.
       
    29 light-&gt;LightOnL( CHWRMLight::ESecondaryDisplay, 5000, 500, 500, 30 );</codeblock><p>For
       
    30 device default cycle duration, use the <codeph>KHWRMDefaultCycleTime</codeph> value.
       
    31 If either <codeph>aOnDuration</codeph> or <codeph>aOffDuration</codeph> is <codeph>KHWRMDefaultCycleTime</codeph>,
       
    32 both must be <codeph>KHWRMDefaultCycleTime</codeph>.</p><p><b>NOTE</b>: Some
       
    33 devices may not support variable blink cycle times. In such scenarios, default
       
    34 value is substituted. All devices may not support user-defined intensity,
       
    35 during which the device behaves in its default state.</p></context>
       
    36 </taskbody></task>