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