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:  Customization manager

    15 *

    16 */

    17 

    18 

    19 #ifndef C_BUBBLECUSTOMMANAGER_H

    20 #define C_BUBBLECUSTOMMANAGER_H

    21 

    22 #include <e32base.h>

    23 #include "BMBubbleManager.h"

    24 #include "telbubblecustomelement.h"

    25 

    26 class CBubbleHeader;

    27 class CBubbleDefaultManager;

    28 class TArrayItem;

    29 

    30 /**

    31  *  Customization manager.

    32  *

    33  *  @lib BubbleManager.lib

    34  *  @since S60 5.0

    35  */

    36 NONSHARABLE_CLASS( CBubbleCustomManager ) : public CBase

    37     {

    38 public:

    39     /**

    40      * Two-phased constructor.

    41      * @param aBubbleManager Bubble manager.

    42      */

    43     static CBubbleCustomManager* NewL( CBubbleManager& aBubbleManager );

    44     

    45     /**

    46     * Destructor.

    47     */

    48     virtual ~CBubbleCustomManager();

    49 

    50     /**

    51      * Adds custom element to call bubble. Ownership is not transferred.

    52      *

    53      * @since S60 5.0

    54      * @param aBubbleId Bubble identifier.

    55      * @param aElement Custom element.

    56      * @param aPriority Priority 0(high) - 255(low). 

    57      */

    58     void AddCustomElement( 

    59         const CBubbleManager::TBubbleId& aBubbleId,

    60         CTelBubbleCustomElement* aElement,

    61         TInt aPriority );

    62     

    63     /**

    64      * Removes custom element from call bubble.

    65      *

    66      * @since S60 5.0

    67      * @param aBubbleId Bubble identifier.

    68      * @param aElement Custom element.

    69      */

    70     void RemoveCustomElement(

    71         const CBubbleManager::TBubbleId& aBubbleId,

    72         CTelBubbleCustomElement* aElement );

    73     

    74     /**

    75      * Removes all custom elements related to given bubble.

    76      *

    77      * @since S60 5.0

    78      * @param aBubbleId Bubble identifier.

    79      */

    80     void RemoveCustomElements( const CBubbleManager::TBubbleId& aBubbleId );

    81     

    82     /**

    83      * Reserves custom element. Default elements are

    84      * shared between call bubbles.

    85      *

    86      * @since S60 5.0

    87      * @param aBubbleId Bubble identifier.

    88      * @param aElement Element type.

    89      * return Element instance.

    90      */

    91     CTelBubbleCustomElement* ReserveCustomElement( 

    92         const CBubbleHeader& aBubbleHeader,

    93         CTelBubbleCustomElement::TElementType aElement );

    94     

    95     /**

    96      * Reserves custom element. Default elements are

    97      * shared between call bubbles.

    98      *

    99      * @since S60 5.0

   100      * @param aBubbleId Bubble identifier.

   101      * @param aElement Element type.

   102      * @param aIsDefault Is ETrue, when default implementation is used.

   103      * return Element instance.

   104      */

   105     CTelBubbleCustomElement* ReserveCustomElement( 

   106         const CBubbleHeader& aBubbleHeader,

   107         CTelBubbleCustomElement::TElementType aElement,

   108         TBool& aIsDefault );

   109     

   110     /**

   111      * Releases custom element.

   112      *

   113      * @since S60 5.0

   114      * @param aElement Released custom element.

   115      */

   116     void ReleaseCustomElement( CTelBubbleCustomElement*& aCustomElement );

   117     

   118 private:

   119     CTelBubbleCustomElement* DefaultElement( 

   120         const CBubbleHeader& aBubbleHeader,

   121         CTelBubbleCustomElement::TElementType aElement );

   122 

   123 private:

   124     CBubbleCustomManager( CBubbleManager& aBubbleManager );

   125     void ConstructL();

   126 

   127 private: // data

   128     CBubbleManager&       iBubbleManager;

   129 

   130     TFixedArray< TFixedArray< RArray<TArrayItem>, 

   131                               CTelBubbleCustomElement::ECustomElementCount >, 

   132                  KBubbleCallMaxAmount > iCustomizations;

   133     

   134     CBubbleDefaultManager* iDefaultManager; // owned

   135     };

   136 

   137 #endif // C_BUBBLECUSTOMMANAGER_H