epoc32/include/mw/eiklbo.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-2009 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(__EIKLBO_H__)
williamr@2
    20
#define __EIKLBO_H__
williamr@2
    21
williamr@2
    22
class CEikListBox; 
williamr@2
    23
williamr@2
    24
/**
williamr@2
    25
* List box observer interface.
williamr@2
    26
*
williamr@2
    27
* Each list box observer may be registered with a number of list
williamr@2
    28
* boxes; each of these send events to the list box observer through
williamr@2
    29
* its HandeListBoxEventL() method.
williamr@2
    30
*
williamr@2
    31
* Writing derived classes: 
williamr@2
    32
*
williamr@2
    33
* Application authors should implement a class which derives from this
williamr@2
    34
* interface to receive events from list boxes
williamr@2
    35
*/
williamr@2
    36
class MEikListBoxObserver
williamr@2
    37
    {
williamr@2
    38
    public:
williamr@2
    39
williamr@2
    40
        /**
williamr@2
    41
        * List box event codes
williamr@2
    42
        */
williamr@2
    43
        enum TListBoxEvent
williamr@2
    44
            {
williamr@2
    45
            /**  Keypress event. */
williamr@2
    46
            EEventEnterKeyPressed,
williamr@2
    47
            /**  Item single-tap event */
williamr@2
    48
            EEventItemClicked,
williamr@2
    49
            /**  Item two-taps event. */
williamr@2
    50
            EEventItemDoubleClicked,
williamr@2
    51
            /**  Special event: reported by directory tree and directory contents list boxes. */
williamr@2
    52
            EEventItemActioned,
williamr@2
    53
            /**  Editing started. */
williamr@2
    54
            EEventEditingStarted,
williamr@2
    55
            /**  Editing stopped. */
williamr@2
    56
            EEventEditingStopped,
williamr@2
    57
            /**  Pen is down and over an item */
williamr@2
    58
            EEventPenDownOnItem,
williamr@2
    59
            /**  Pen is dragged from item to another */
williamr@2
    60
            EEventItemDraggingActioned,
williamr@2
    61
            /**  Panning is started */
williamr@2
    62
            EEventPanningStarted,
williamr@2
    63
            /**  Panning is stopped */
williamr@2
    64
            EEventPanningStopped,
williamr@2
    65
            /**  Flick is started */
williamr@2
    66
            EEventFlickStarted,
williamr@2
    67
            /**  Flick is stopped */
williamr@4
    68
            EEventFlickStopped,
williamr@4
    69
            /**  Item single-tap event. This event should be used
williamr@4
    70
             by applications that are single click compatible. */
williamr@4
    71
            EEventItemSingleClicked,
williamr@4
    72
			/**  An empty listbox was clicked */
williamr@4
    73
            EEventEmptyListClicked,
williamr@4
    74
            /**  An empty area of non-empty listbox was clicked */
williamr@4
    75
            EEventEmptyAreaClicked         
williamr@2
    76
            };
williamr@2
    77
williamr@2
    78
    public:
williamr@2
    79
        /**
williamr@2
    80
        * Handles list box events.
williamr@2
    81
        *
williamr@2
    82
        * This pure virtual function is invoked by CEikListBox to
williamr@2
    83
        * notify the observer of list box events.
williamr@2
    84
        *
williamr@2
    85
        * @param aListBox   The originating list box.
williamr@2
    86
        * @param aEventType A code for the event. Further information 
williamr@2
    87
        *                   may be obtained by accessing the list box itself.
williamr@2
    88
        */
williamr@2
    89
        virtual void HandleListBoxEventL(CEikListBox* aListBox, TListBoxEvent aEventType)=0;
williamr@2
    90
    };
williamr@2
    91
williamr@2
    92
#endif