epoc32/include/mw/eiklbo.h
branchSymbian2
changeset 2 2fe1408b6811
parent 1 666f914201fb
child 4 837f303aceeb
     1.1 --- a/epoc32/include/mw/eiklbo.h	Tue Nov 24 13:55:44 2009 +0000
     1.2 +++ b/epoc32/include/mw/eiklbo.h	Tue Mar 16 16:12:26 2010 +0000
     1.3 @@ -1,1 +1,85 @@
     1.4 -eiklbo.h
     1.5 +/*
     1.6 +* Copyright (c) 1997-2009 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(__EIKLBO_H__)
    1.24 +#define __EIKLBO_H__
    1.25 +
    1.26 +class CEikListBox; 
    1.27 +
    1.28 +/**
    1.29 +* List box observer interface.
    1.30 +*
    1.31 +* Each list box observer may be registered with a number of list
    1.32 +* boxes; each of these send events to the list box observer through
    1.33 +* its HandeListBoxEventL() method.
    1.34 +*
    1.35 +* Writing derived classes: 
    1.36 +*
    1.37 +* Application authors should implement a class which derives from this
    1.38 +* interface to receive events from list boxes
    1.39 +*/
    1.40 +class MEikListBoxObserver
    1.41 +    {
    1.42 +    public:
    1.43 +
    1.44 +        /**
    1.45 +        * List box event codes
    1.46 +        */
    1.47 +        enum TListBoxEvent
    1.48 +            {
    1.49 +            /**  Keypress event. */
    1.50 +            EEventEnterKeyPressed,
    1.51 +            /**  Item single-tap event */
    1.52 +            EEventItemClicked,
    1.53 +            /**  Item two-taps event. */
    1.54 +            EEventItemDoubleClicked,
    1.55 +            /**  Special event: reported by directory tree and directory contents list boxes. */
    1.56 +            EEventItemActioned,
    1.57 +            /**  Editing started. */
    1.58 +            EEventEditingStarted,
    1.59 +            /**  Editing stopped. */
    1.60 +            EEventEditingStopped,
    1.61 +            /**  Pen is down and over an item */
    1.62 +            EEventPenDownOnItem,
    1.63 +            /**  Pen is dragged from item to another */
    1.64 +            EEventItemDraggingActioned,
    1.65 +            /**  Panning is started */
    1.66 +            EEventPanningStarted,
    1.67 +            /**  Panning is stopped */
    1.68 +            EEventPanningStopped,
    1.69 +            /**  Flick is started */
    1.70 +            EEventFlickStarted,
    1.71 +            /**  Flick is stopped */
    1.72 +            EEventFlickStopped
    1.73 +            };
    1.74 +
    1.75 +    public:
    1.76 +        /**
    1.77 +        * Handles list box events.
    1.78 +        *
    1.79 +        * This pure virtual function is invoked by CEikListBox to
    1.80 +        * notify the observer of list box events.
    1.81 +        *
    1.82 +        * @param aListBox   The originating list box.
    1.83 +        * @param aEventType A code for the event. Further information 
    1.84 +        *                   may be obtained by accessing the list box itself.
    1.85 +        */
    1.86 +        virtual void HandleListBoxEventL(CEikListBox* aListBox, TListBoxEvent aEventType)=0;
    1.87 +    };
    1.88 +
    1.89 +#endif