phone_plat/telephony_bubble_extension_api/inc/telbubbleextensioninterface.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:  Bubble extension interface.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef TELBUBBLEEXTENSIONINTERFACE_H
       
    20 #define TELBUBBLEEXTENSIONINTERFACE_H
       
    21 
       
    22 #include <e32base.h>
       
    23 
       
    24 class MTelBubbleExtensionData;
       
    25 
       
    26 class MTelBubbleExtensionInterface
       
    27     {
       
    28 public:
       
    29 
       
    30     /**
       
    31      * Notifies that a new customizable bubble is available.
       
    32      *
       
    33      * This function is called when a new bubbleheader is created. Plugin
       
    34      * should initiate a new customization instance inside this method and
       
    35      * store the reference to the call data.
       
    36      *
       
    37      * @param aCallData Reference to call data.
       
    38      */
       
    39     virtual void StartCustomizedBubble(
       
    40             MTelBubbleExtensionData& aCallData ) = 0;
       
    41 
       
    42     /**
       
    43      * Notifies that a customizable bubble has been removed
       
    44      *
       
    45      * This function is called when a bubbleheader is going to be deleted.
       
    46      * Plugin should detach all customizations related to this call and
       
    47      * delete the local datas related to this call.
       
    48      *
       
    49      * @param aCallData Reference to call data.
       
    50      */
       
    51     virtual void StopCustomizedBubble(
       
    52             MTelBubbleExtensionData& aCallData ) = 0;
       
    53 
       
    54     /**
       
    55      * Indicates that currently bubble drawing is started.
       
    56      * Customizing is preferred to be done during this call.
       
    57      *
       
    58      * This function is called when the call bubbles are being updated.
       
    59      * The call datas are updated before this function is called. Plugin should
       
    60      * check whether any of the calls are changed so that change to the
       
    61      * customized element is needed and make the change. Doing the
       
    62      * changes during this method will prevent excess flickering and
       
    63      * redraws and therefore is suggested.
       
    64      */
       
    65     virtual void BubbleUpdating() = 0;
       
    66 
       
    67     };
       
    68 
       
    69 #endif // TELBUBBLEEXTENSIONINTERFACE_H
       
    70 
       
    71 // end of file