landmarksui/app/inc/MLmkKeyProcessor.h
branchRCL_3
changeset 17 1fc85118c3ae
parent 16 8173571d354e
child 18 870918037e16
equal deleted inserted replaced
16:8173571d354e 17:1fc85118c3ae
     1 /*
       
     2 * Copyright (c) 2002 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:    LandmarksUi Content File -
       
    15 *     Interface which allows subscribers to consume key event or pass the event
       
    16 *     to other view class.
       
    17 *
       
    18 */
       
    19 
       
    20 
       
    21 
       
    22 
       
    23 
       
    24 
       
    25 
       
    26 #ifndef MLmkKeyProcessor_H
       
    27 #define MLmkKeyProcessor_H
       
    28 
       
    29 // INCLUDES
       
    30 #include <w32std.h>
       
    31 
       
    32 // FORWARD DECLARATIONS
       
    33 class MAknTabObserver;
       
    34 
       
    35 // ===========================================================================
       
    36 // MLmkKeyProcessor
       
    37 // ===========================================================================
       
    38 
       
    39 /**
       
    40 *	An interface a CCoeControl class can implement to forward the keyevents
       
    41 *   before the actual control gets the key events. This is useful in
       
    42 *   situations where the control consumes keys which you need.
       
    43 */
       
    44 class MLmkKeyProcessor
       
    45     {
       
    46     public:
       
    47     /**
       
    48     * process the keyevent befor it reaches the control
       
    49     * @param aKeyEvent the event fired
       
    50     * @param aType the type of event
       
    51     * @return ETrue if key event was consumed, otherwise EFalse
       
    52     */
       
    53     virtual TBool ProcessKeyEventL( const TKeyEvent& aKeyEvent,
       
    54                                     TEventCode aType ) = 0;
       
    55 
       
    56 	/**
       
    57     * returns the pointer to MAknTabObserver interface
       
    58     * @return pointer to the MAknTabObserver interface
       
    59     */
       
    60     virtual MAknTabObserver* TabObserver() = 0;
       
    61     };
       
    62 
       
    63 
       
    64 #endif
       
    65 
       
    66 // End of File