1 /*

     2 * Copyright (c) 2006 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 "Eclipse Public License v1.0"

     6 * which accompanies this distribution, and is available

     7 * at the URL "http://www.eclipse.org/legal/epl-v10.html".

     8 *

     9 * Initial Contributors:

    10 * Nokia Corporation - initial contribution.

    11 *

    12 * Contributors:

    13 *

    14 * Description:  Event handler base class for Active Idle WS Plug-in.

    15 *

    16 */

    17 

    18 

    19 #ifndef C_AIWSPLUGIN_EVENTHANDLER_H

    20 #define C_AIWSPLUGIN_EVENTHANDLER_H

    21 

    22 

    23 #include <e32base.h>

    24 

    25 class TRawEvent;

    26 

    27 namespace AiWsPlugin {

    28 

    29 class MUiState;

    30 

    31 /**

    32  *  @ingroup group_wsplugin

    33  *

    34  *  Event handler base class for Active Idle WS Plug-in.

    35  *

    36  *  Window server plug-in animation class CAiWsPluginAnim forwards events to 

    37  * instances of this class for processing.

    38  *

    39  *  @since S60 3.2

    40  */

    41 class CEventHandler : public CBase

    42     {

    43 public:

    44     /**

    45      * Sets the UI State query interface for this event handler.

    46      */

    47     virtual void SetUiStateQuery( MUiState& aUiState ) =0;

    48 

    49     /**

    50      * Calls to CWindowAnim::FocusChanged are forwarded to this function.

    51      *

    52      * @param Indicates whether the focus has or has not changed.

    53      */

    54     virtual void FocusChanged( TBool aState ) =0;

    55     

    56     /**

    57      * Calls to CWindowAnim::OfferRawEvent are forwarded to this function.

    58      * Forwarding is stopped if this function returns true.

    59      *

    60      * @param aRawEvent The raw event to be processed.

    61      * @return ETrue if the raw event is handled by this function, EFalse if 

    62      *         the function chooses not to process it. 

    63      */

    64     virtual TBool OfferRawEvent(const TRawEvent& aRawEvent) =0;

    65     };

    66 

    67 } // namespace AiWsPlugin

    68 

    69 #endif // C_AIWSPLUGIN_EVENTHANDLER_H