phone_plat/telephony_bubble_extension_api/inc/telbubbleextension.h
branchGCC_SURGE
changeset 51 f39ed5e045e0
parent 40 bab96b7ed1a4
parent 46 bc5a64e5bc3c
equal deleted inserted replaced
40:bab96b7ed1a4 51:f39ed5e045e0
     1 /*
       
     2 * Copyright (c) 2008 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:  Base class for extension plug-in.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef TELBUBBLEEXTENSION_H
       
    20 #define TELBUBBLEEXTENSION_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <e32base.h>
       
    24 #include "telbubbleextensioninterface.h"
       
    25 
       
    26 // CONSTANTS
       
    27 // Constants used in ECOM implementation
       
    28 const TUid KTelBubbleExtensionInterfaceUid    = { 0x102078F6 };
       
    29 
       
    30 class MTelBubbleExtensionObserver;
       
    31 class MTelBubbleExtensionData;
       
    32 
       
    33 class CTelBubbleExtension : public CBase,
       
    34                             public MTelBubbleExtensionInterface
       
    35     {
       
    36 public:
       
    37     /**
       
    38     * Two phase constructor
       
    39     *
       
    40     * @leave Uses Leave code KErrNotFound if implementation is not found.
       
    41     * @param aImplementationUid Implementation UID of the plugin to be
       
    42     *        created.
       
    43     */
       
    44     static CTelBubbleExtension* NewL(
       
    45         TUid aImplementationUid );
       
    46 
       
    47     /** Destructor */
       
    48     virtual inline ~CTelBubbleExtension();
       
    49 
       
    50     /**
       
    51      * Initialize plug-in. Called after NewL
       
    52      * @param aBubbles Interface for bubbles
       
    53      */
       
    54     virtual void InitializeL( MTelBubbleExtensionObserver& aBubbles ) = 0;
       
    55 
       
    56 // from MTelBubbleExtensionInterface
       
    57 
       
    58     /**
       
    59      * Notifies that a new customizable bubble is available
       
    60      *
       
    61      * @param aCallData Reference to call data.
       
    62      */
       
    63     virtual void StartCustomizedBubble(
       
    64             MTelBubbleExtensionData& aCallData ) = 0;
       
    65 
       
    66     /**
       
    67      * Notifies that a customizable bubble has been removed
       
    68      *
       
    69      * @param aCallData Reference to call data.
       
    70      */
       
    71     virtual void StopCustomizedBubble(
       
    72             MTelBubbleExtensionData& aCallData ) = 0;
       
    73 
       
    74     /**
       
    75      * Indicates that currently bubble drawing is started.
       
    76      * Customizing is preferred to be done during this call.
       
    77      */
       
    78     virtual void BubbleUpdating() = 0;
       
    79 
       
    80 private: // data
       
    81 
       
    82     /**
       
    83      * ECOM plugin instance UID.
       
    84      */
       
    85     TUid iDtor_ID_Key;
       
    86     };
       
    87 
       
    88 #include "telbubbleextension.inl"
       
    89 
       
    90 #endif // TELBUBBLEEXTENSION_H
       
    91 
       
    92 // end of file