epoc32/include/mw/eiksbobs.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/eiksbobs.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/eiksbobs.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,82 @@
     1.4 -eiksbobs.h
     1.5 +/*
     1.6 +* Copyright (c) 1997-1999 Nokia Corporation and/or its subsidiary(-ies).
     1.7 +* All rights reserved.
     1.8 +* This component and the accompanying materials are made available
     1.9 +* 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
    1.10 +* which accompanies this distribution, and is available
    1.11 +* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
    1.12 +*
    1.13 +* Initial Contributors:
    1.14 +* Nokia Corporation - initial contribution.
    1.15 +*
    1.16 +* Contributors:
    1.17 +*
    1.18 +* Description:
    1.19 +*
    1.20 +*/
    1.21 +
    1.22 +
    1.23 +#if !defined(__EIKSBOBS_H__)
    1.24 +#define __EIKSBOBS_H__
    1.25 +
    1.26 +/**
    1.27 + *
    1.28 + * Scroll bar events enumerations 
    1.29 + *
    1.30 + * Touch events for scroll bar. Reported to scroll bar observer through 
    1.31 + * HandleScrollEventL method.
    1.32 + *
    1.33 + *  @since S60 0.9
    1.34 + */
    1.35 +enum TEikScrollEvent
    1.36 +    {
    1.37 +    EEikScrollLeft=1, /** stulys was tapped on the left arrow of the scroll bar */
    1.38 +    EEikScrollUp, /** stulys was tapped on the up arrow of the scroll bar */
    1.39 +    EEikScrollRight, /** stulys was tapped on the right arrow of the scroll bar */
    1.40 +    EEikScrollDown, /** stulys was tapped on the down arrow of the scroll bar */
    1.41 +    EEikScrollPageLeft, /** stulys was tapped on left side of the scroll bar */
    1.42 +    EEikScrollPageUp, /** stulys was tapped above the scroll bar */
    1.43 +    EEikScrollPageRight, /** stulys was tapped on right side of the scroll bar */
    1.44 +    EEikScrollPageDown, /** stulys was tapped below the scroll bar */
    1.45 +    EEikScrollHome, /** @deprecated */
    1.46 +    EEikScrollTop, /** @deprecated */
    1.47 +    EEikScrollEnd, /** @deprecated */
    1.48 +    EEikScrollBottom, /** @deprecated */
    1.49 +    EEikScrollThumbDragHoriz, /** stulys is down on scroll bar thumb and dragged */
    1.50 +    EEikScrollThumbDragVert, /** stulys is down on scroll bar thumb and dragged */
    1.51 +    EEikScrollThumbReleaseHoriz, /** scrollbar thumb drag is stopped */
    1.52 +    EEikScrollThumbReleaseVert /** scrollbar thumb drag is stopped */
    1.53 +    };
    1.54 +
    1.55 +class CEikScrollBar;
    1.56 +
    1.57 +/**
    1.58 + * Scroll bar observer interface
    1.59 + *
    1.60 + * Scroll bar clients can registers itself to observe scroll bar events. 
    1.61 + * The scroll bar sends an event to the observer every time a touch event 
    1.62 + * happens for the scroll bar.
    1.63 + *
    1.64 + * Clients should derive from MEikScrollBarObserver interface to get scroll bar events. 
    1.65 + *
    1.66 + *  @lib eikcoctl.lib
    1.67 + *  @since S60 0.9
    1.68 + */
    1.69 +
    1.70 +class MEikScrollBarObserver
    1.71 +    {
    1.72 +public:
    1.73 +
    1.74 +    /**
    1.75 +     * Callback method for scroll bar events
    1.76 +     *
    1.77 +     * Scroll bar observer should implement this method to get scroll bar events.
    1.78 +     *
    1.79 +     * @since S60 0.9
    1.80 +     * @param aScrollBar A pointer to scrollbar which created the event
    1.81 +     * @param aEventType The event occured on the scroll bar
    1.82 +     */
    1.83 +    virtual void HandleScrollEventL(CEikScrollBar* aScrollBar, TEikScrollEvent aEventType)=0;
    1.84 +    };
    1.85 +
    1.86 +#endif // __EIKSBOBS_H__