phonebookui/Phonebook2/UIControls/inc/MPbk2ControlKeyObserver.h
branchRCL_3
changeset 20 f4a778e096c2
parent 0 e686773b3f54
equal deleted inserted replaced
19:5b6f26637ad3 20:f4a778e096c2
       
     1 /*
       
     2 * Copyright (c) 2002-2007 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: 
       
    15 *      Phonebook 2 UI control key event observer.
       
    16 *
       
    17 */
       
    18 
       
    19 
       
    20 #ifndef MPBK2CONTROLKEYOBSERVER_H
       
    21 #define MPBK2CONTROLKEYOBSERVER_H
       
    22 
       
    23 //  INCLUDES
       
    24 #include <coedef.h> // TKeyResponse
       
    25 #include <w32std.h> // TKeyEvent, TEventCode
       
    26 
       
    27 // CLASS DECLARATION
       
    28 
       
    29 /**
       
    30  * @internal Only Phonebook 2 internal use supported!
       
    31  *
       
    32  * Phonebook 2 UI control key event observer interface.
       
    33  */
       
    34 class MPbk2ControlKeyObserver
       
    35     {
       
    36     public:  // Interface
       
    37         /**
       
    38          * Called from OfferKeyEventL of the observed control.
       
    39          *
       
    40          * @param aKeyEvent   see CCoeControl::OfferKeyEventL.
       
    41          * @param aType       see CCoeControl::OfferKeyEventL.
       
    42          * @return see CCoeControl::OfferKeyEventL.
       
    43          * @see CCoeControl::OfferKeyEventL. If returns EKeyWasConsumed the 
       
    44          *      control should not forward the key event.
       
    45          */
       
    46         virtual TKeyResponse Pbk2ControlKeyEventL
       
    47             (const TKeyEvent& aKeyEvent,TEventCode aType) = 0;
       
    48     };
       
    49 
       
    50 #endif // MPBK2CONTROLKEYOBSERVER_H
       
    51 
       
    52 // End of File