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 -->  <!DOCTYPE concept PUBLIC "-//OASIS//DTD DITA Concept//EN" "concept.dtd"><concept id="GUID-11C24609-3B6D-4B44-B003-FB0C07444A9E" xml:lang="en"><title>Scroll

    10 pane</title><prolog><metadata><keywords></keywords></metadata></prolog><conbody>

    11 <p>With any list, grid or other component that can be scrolled vertically,

    12 a scrollbar appears on the right-hand side of the component. The scrollbar

    13 is displayed also on pop-up components.</p>

    14 <fig id="GUID-BD8A5FCD-048E-41AF-BA17-A38B689141D9">

    15 <title>Scroll pane with scrollbar</title>

    16 <image href="GUID-F8A7F4CB-011C-425D-83B4-13BD67AA21B7_d0e53932_href.png" scale="33" placement="inline"></image>

    17 </fig>

    18 <ul>

    19 <li><p>The placement of the scroll handle on the scrollbar reflects the position

    20 of the focus on the scrolling content.</p></li>

    21 <li><p>The size of the scroll handle reflects the number of displayed items

    22 relative to the total number of items on the scrolled component.</p></li>

    23 <li><p>The scrollbar is displayed even when all items on the component can

    24 be displayed in the same view without scrolling. When this is the case, the

    25 scroll handle is displayed at the maximum size. The only exception is the

    26 Application Shell, where scrollbar is not displayed if all items fit the same

    27 view.</p></li>

    28 </ul>

    29 <section id="GUID-054FE843-7681-40D9-ACA7-47122BC3107B"><title>Scrollbars

    30 in Touch UI</title><p>In touch devices based on the Symbian platform,

    31 scrollbars (vertical and horizontal) have a touch-enabled scroll box. The

    32 hardware keys (Arrow keys) can also be used for scrolling when the scrollbars

    33 are visible. The scrolling movement on the screen is smooth.</p><p>In order

    34 for the scrollbar to be more usable with touch, the actual scrollbar area

    35 is wider than the visible scrollbar. When the user scrolls, the scrollbar

    36 has a related effect to indicate the scrolling. Because the actual area of

    37 scrollbar is wider, the items appearing on that area in scrollable list, grids,

    38 viewers etc. cannot be touch-enabled, e.g. list icons in column D cannot be

    39 tapped.</p></section>

    40 <section id="GUID-87093F25-CFC3-4D71-A5EF-006C6425C65D"><title>Using

    41 scrollbars in C++ applications</title><p>The API to use for creating the scrollbar

    42 component is the Scroller

    43 API.</p><p>To use a scrollbar in your application, first create a scrollbar

    44 frame using the class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCEikScrollBarFrame.html" format="application/java-archive"><codeph>CEikScrollbarFrame</codeph></xref>. All scrollbar operations are executed via this scrollbar frame.

    45 These operations include creating and destroying the scrollbar, setting its

    46 visibility, and adjusting the scrollbar's model. The scrollbar itself can

    47 be created using the method <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCEikScrollBarFrame.html#81980f8db36253fc89fb7ebbfa316b4d" format="application/java-archive"><codeph>CreateDoubleSpanScrollBarsL()</codeph></xref> in the class <codeph>CEikScrollBarFrame</codeph>.

    48 The class for the scrollbar is <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCAknDoubleSpanScrollBar.html" format="application/java-archive"><codeph>CAknDoubleSpanScrollBar</codeph></xref>. For implementation information, see Creating

    49 a scrollbar.</p><p>Scrollbar models encapsulate the range of integers

    50 which a scrollbar can represent, from zero to n, and the current position

    51 of the scrollbar thumb within that range. To set the scrollbar model, use

    52 the class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classTAknDoubleSpanScrollBarModel.html" format="application/java-archive"><codeph>TAknDoubleSpanScrollbarModel</codeph></xref>. For information on updating the scrollbar's position and size using

    53 the scrollbar model, see Updating

    54 ArrowHead scrollbar attributes and Updating

    55 DoubleSpan scrollbar attributes.</p><p>You can control the scrollbar

    56 visibility using the method <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCEikScrollBarFrame.html#63d2cba6f1261f9c56dd7a98499fceda" format="application/java-archive"><codeph>SetScrollbarVisibilityL()</codeph></xref> in the class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classCEikScrollBarFrame.html" format="application/java-archive"><codeph>CEikScrollbarFrame</codeph></xref>.</p><p>To observed scrollbar events,

    57 use the class <xref href="jar:GUID-759FBC7F-5384-4487-8457-A8D4B76F6AA6.jar!/html/classMEikScrollBarObserver.html" format="application/java-archive"><codeph>MEikScrollbarObserver</codeph></xref>. For implementation information, see Observing

    58 scrollbar events.</p></section>

    59 </conbody></concept>