Symbian3/SDK/Source/GUID-11C24609-3B6D-4B44-B003-FB0C07444A9E.dita
changeset 8 ae94777fff8f
parent 7 51a74ef9ed63
child 13 48780e181b38
equal deleted inserted replaced
7:51a74ef9ed63 8:ae94777fff8f
    13 <p>With any list, grid or other component that can be scrolled vertically,
    13 <p>With any list, grid or other component that can be scrolled vertically,
    14 a scrollbar appears on the right-hand side of the component. The scrollbar
    14 a scrollbar appears on the right-hand side of the component. The scrollbar
    15 is displayed also on pop-up components.</p>
    15 is displayed also on pop-up components.</p>
    16 <fig id="GUID-1C685A4B-F3EF-4A43-9233-E84C67FD74F4">
    16 <fig id="GUID-1C685A4B-F3EF-4A43-9233-E84C67FD74F4">
    17 <title>Scroll pane with scrollbar</title>
    17 <title>Scroll pane with scrollbar</title>
    18 <image href="GUID-3382507E-1B21-418C-A908-DD3F688C0672_d0e73223_href.png" placement="inline"/>
    18 <image href="GUID-3382507E-1B21-418C-A908-DD3F688C0672_d0e68090_href.png" placement="inline"/>
    19 </fig>
    19 </fig>
    20 <ul>
    20 <ul>
    21 <li><p>The placement of the scroll handle on the scrollbar reflects the position
    21 <li><p>The placement of the scroll handle on the scrollbar reflects the position
    22 of the focus on the scrolling content.</p></li>
    22 of the focus on the scrolling content.</p></li>
    23 <li><p>The size of the scroll handle reflects the number of displayed items
    23 <li><p>The size of the scroll handle reflects the number of displayed items
    24 relative to the total number of items on the scrolled component.</p></li>
    24 relative to the total number of items on the scrolled component.</p></li>
    25 <li><p>The scrollbar is displayed even when all items on the component can
    25 <li><p>The scrollbar can be displayed in the same view without scrolling.
    26 be displayed in the same view without scrolling. When this is the case, the
    26 When this is the case, the scroll handle is displayed at the maximum size.
    27 scroll handle is displayed at the maximum size. The only exception is the
    27 The only exception is the Application Shell, where scrollbar is not displayed
    28 Application Shell, where scrollbar is not displayed if all items fit the same
    28 if all items fit the same view.</p></li>
    29 view.</p></li>
       
    30 </ul>
    29 </ul>
    31 <section id="GUID-054FE843-7681-40D9-ACA7-47122BC3107B"><title>Scrollbars
    30 <section id="GUID-054FE843-7681-40D9-ACA7-47122BC3107B"><title>Scrollbars
    32 in Touch UI</title><p>In touch devices based on the Symbian platform, scrollbars
    31 in Touch UI</title><p>In touch devices based on the Symbian platform, scrollbars
    33 (vertical and horizontal) have a touch-enabled scroll box. The hardware keys
    32 (vertical and horizontal) have a touch-enabled scroll box. The hardware keys
    34 (Arrow keys) can also be used for scrolling when the scrollbars are visible.
    33 (Arrow keys) can also be used for scrolling when the scrollbars are visible.</p><p>For
    35 The scrolling movement on the screen is smooth.</p><p>For the scrollbar to
    34 the scrollbar to be more usable with touch, the actual scrollbar area is wider
    36 be more usable with touch, the actual scrollbar area is wider than the visible
    35 than the visible scrollbar. When the user scrolls, the scrollbar has a related
    37 scrollbar. When the user scrolls, the scrollbar has a related effect to indicate
    36 effect to indicate the scrolling. Because the actual area of scrollbar is
    38 the scrolling. Because the actual area of scrollbar is wider, the items appearing
    37 wider, the items appearing on that area in scrollable list, grids, viewers
    39 on that area in scrollable list, grids, viewers cannot be touch-enabled, for
    38 cannot be touch-enabled, for example,list icons in column D cannot be tapped.</p><table id="GUID-96CBFEBF-601B-4686-85B2-7E634AB1F1B2"><title>Default control events
    40 example,list icons in column D cannot be tapped.</p><table id="GUID-96CBFEBF-601B-4686-85B2-7E634AB1F1B2">
    39 for scrollbar.</title>
    41 <title>Default control events for scrollbar.</title>
       
    42 <tgroup cols="3"><colspec colname="col1" colwidth="0.80*"/><colspec colname="col2" colwidth="1.01*"/><colspec colname="col3" colwidth="1.19*"/>
    40 <tgroup cols="3"><colspec colname="col1" colwidth="0.80*"/><colspec colname="col2" colwidth="1.01*"/><colspec colname="col3" colwidth="1.19*"/>
    43 <thead>
    41 <thead>
    44 <row>
    42 <row>
    45 <entry valign="top"><p>User action</p></entry>
    43 <entry valign="top"><p>User action</p></entry>
    46 <entry valign="top"><p>State change</p></entry>
    44 <entry valign="top"><p>State change</p></entry>
   104 </row>
   102 </row>
   105 </tbody>
   103 </tbody>
   106 </tgroup>
   104 </tgroup>
   107 </table></section>
   105 </table></section>
   108 <section id="GUID-87093F25-CFC3-4D71-A5EF-006C6425C65D"><title>Using
   106 <section id="GUID-87093F25-CFC3-4D71-A5EF-006C6425C65D"><title>Using
   109 scrollbars in C++ applications</title><p>The API to use for creating the scrollbar
   107 scrollbars in applications</title><p>The API to use for creating the scrollbar
   110 component is the <xref format="html" href="specs/guides/Scroller_API_Specification/Scroller_API_Specification.html" scope="peer">Scroller API</xref>.</p><p>To use a scrollbar in your application,
   108 component is the <xref format="html" href="specs/guides/Scroller_API_Specification/Scroller_API_Specification.html" scope="peer">Scroller API</xref>.</p><p>To use a scrollbar in your application,
   111 first create a scrollbar 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.
   109 first create a scrollbar frame using the<xref href="GUID-1277B47A-85B4-35D3-8599-7D6CC839E780.dita"><apiname>CEikScrollbarFrame</apiname></xref> class.
   112 These operations include creating and destroying the scrollbar, setting its
   110 All scrollbar operations are executed via this scrollbar frame. These operations
   113 visibility, and adjusting the scrollbar's model. The scrollbar itself can
   111 include creating and destroying the scrollbar, setting its visibility, and
   114 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>.
   112 adjusting the scrollbar's model. The scrollbar itself can be created using
       
   113 the <xref href="GUID-19DCF868-FA99-3714-83D1-527EFF9C673B.dita#GUID-19DCF868-FA99-3714-83D1-527EFF9C673B/GUID-73C9FB55-A88B-35EE-8AE5-88B511C675D5"><apiname>CEikScrollBarFrame::CreateDoubleSpanScrollBarsL()</apiname></xref> method.
   115 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 <xref format="html" href="specs/guides/Scroller_API_Specification/Scroller_API_Specification.html#Scroller_API_Specification.topic3.1" scope="peer">Creating a scrollbar</xref>.</p><p>Scrollbar models encapsulate
   114 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 <xref format="html" href="specs/guides/Scroller_API_Specification/Scroller_API_Specification.html#Scroller_API_Specification.topic3.1" scope="peer">Creating a scrollbar</xref>.</p><p>Scrollbar models encapsulate
   116 the range of integers which a scrollbar can represent, from zero to n, and
   115 the range of integers which a scrollbar can represent, from zero to n, and
   117 the current position of the scrollbar thumb within that range. To set the
   116 the current position of the scrollbar thumb within that range. To set the
   118 scrollbar model, use 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
   117 scrollbar model, use the <xref href="GUID-C48FA73D-8F4A-37BF-8298-C3A7D86AE972.dita"><apiname>TAknDoubleSpanScrollbarModel</apiname></xref> class.
   119 the scrollbar model, see <xref format="html" href="specs/guides/Scroller_API_Specification/Scroller_API_Specification.html#Scroller_API_Specification.topic3.2" scope="peer">Updating ArrowHead scrollbar attributes</xref> and <xref format="html" href="specs/guides/Scroller_API_Specification/Scroller_API_Specification.html#Scroller_API_Specification.topic3.3" scope="peer">Updating DoubleSpan scrollbar attributes</xref>.</p><p>You can
   118 For information on updating the scrollbar's position and size using the scrollbar
   120 control the scrollbar 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,
   119 model, see <xref format="html" href="specs/guides/Scroller_API_Specification/Scroller_API_Specification.html#Scroller_API_Specification.topic3.2" scope="peer">Updating ArrowHead scrollbar attributes</xref> and <xref format="html" href="specs/guides/Scroller_API_Specification/Scroller_API_Specification.html#Scroller_API_Specification.topic3.3" scope="peer">Updating DoubleSpan scrollbar attributes</xref>.</p><p>You can
   121 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 <xref format="html" href="specs/guides/Scroller_API_Specification/Scroller_API_Specification.html.dita#specs/guides/Scroller_API_Specification/Scroller_API_Specification.html/Scroller_API_Specification.topic3.4">Observing scrollbar events</xref>.</p></section>
   120 control the scrollbar visibility using the <xref href="GUID-1277B47A-85B4-35D3-8599-7D6CC839E780.dita#GUID-1277B47A-85B4-35D3-8599-7D6CC839E780/GUID-8AFAE0F6-2C0A-335B-A8B6-996FBF4114D0"><apiname>CEikScrollbarFrame::SetScrollbarVisibilityL()</apiname></xref> method.</p><p>To
       
   121 observe scrollbar events, use the <xref href="GUID-149A9C33-0CD6-3032-8DFA-5723DD248464.dita"><apiname>MEikScrollbarObserver</apiname></xref> class.
       
   122 For implementation information, see <xref format="html" href="specs/guides/Scroller_API_Specification/Scroller_API_Specification.html#Scroller_API_Specification.topic3.4" scope="peer">Observing scrollbar events</xref>.</p></section>
   122 </conbody></concept>
   123 </conbody></concept>