epoc32/include/mw/eiksbobs.h
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 1 666f914201fb
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
     1 /*
     2 * Copyright (c) 1997-1999 Nokia Corporation and/or its subsidiary(-ies).
     3 * All rights reserved.
     4 * This component and the accompanying materials are made available
     5 * under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
     6 * which accompanies this distribution, and is available
     7 * at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
     8 *
     9 * Initial Contributors:
    10 * Nokia Corporation - initial contribution.
    11 *
    12 * Contributors:
    13 *
    14 * Description:
    15 *
    16 */
    17 
    18 
    19 #if !defined(__EIKSBOBS_H__)
    20 #define __EIKSBOBS_H__
    21 
    22 /**
    23  *
    24  * Scroll bar events enumerations 
    25  *
    26  * Touch events for scroll bar. Reported to scroll bar observer through 
    27  * HandleScrollEventL method.
    28  *
    29  *  @since S60 0.9
    30  */
    31 enum TEikScrollEvent
    32     {
    33     EEikScrollLeft=1, /** stulys was tapped on the left arrow of the scroll bar */
    34     EEikScrollUp, /** stulys was tapped on the up arrow of the scroll bar */
    35     EEikScrollRight, /** stulys was tapped on the right arrow of the scroll bar */
    36     EEikScrollDown, /** stulys was tapped on the down arrow of the scroll bar */
    37     EEikScrollPageLeft, /** stulys was tapped on left side of the scroll bar */
    38     EEikScrollPageUp, /** stulys was tapped above the scroll bar */
    39     EEikScrollPageRight, /** stulys was tapped on right side of the scroll bar */
    40     EEikScrollPageDown, /** stulys was tapped below the scroll bar */
    41     EEikScrollHome, /** @deprecated */
    42     EEikScrollTop, /** @deprecated */
    43     EEikScrollEnd, /** @deprecated */
    44     EEikScrollBottom, /** @deprecated */
    45     EEikScrollThumbDragHoriz, /** stulys is down on scroll bar thumb and dragged */
    46     EEikScrollThumbDragVert, /** stulys is down on scroll bar thumb and dragged */
    47     EEikScrollThumbReleaseHoriz, /** scrollbar thumb drag is stopped */
    48     EEikScrollThumbReleaseVert /** scrollbar thumb drag is stopped */
    49     };
    50 
    51 class CEikScrollBar;
    52 
    53 /**
    54  * Scroll bar observer interface
    55  *
    56  * Scroll bar clients can registers itself to observe scroll bar events. 
    57  * The scroll bar sends an event to the observer every time a touch event 
    58  * happens for the scroll bar.
    59  *
    60  * Clients should derive from MEikScrollBarObserver interface to get scroll bar events. 
    61  *
    62  *  @lib eikcoctl.lib
    63  *  @since S60 0.9
    64  */
    65 
    66 class MEikScrollBarObserver
    67     {
    68 public:
    69 
    70     /**
    71      * Callback method for scroll bar events
    72      *
    73      * Scroll bar observer should implement this method to get scroll bar events.
    74      *
    75      * @since S60 0.9
    76      * @param aScrollBar A pointer to scrollbar which created the event
    77      * @param aEventType The event occured on the scroll bar
    78      */
    79     virtual void HandleScrollEventL(CEikScrollBar* aScrollBar, TEikScrollEvent aEventType)=0;
    80     };
    81 
    82 #endif // __EIKSBOBS_H__