phonebookui/Phonebook2/inc/MPbk2UIExtensionIconSupport.h
branchRCL_3
changeset 20 f4a778e096c2
parent 0 e686773b3f54
equal deleted inserted replaced
19:5b6f26637ad3 20:f4a778e096c2
       
     1 /*
       
     2 * Copyright (c) 2005-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:  Phonebook 2 UI extension icon support interface.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MPBK2UIEXTENSIONICONSUPPORT_H
       
    20 #define MPBK2UIEXTENSIONICONSUPPORT_H
       
    21 
       
    22 //  INCLUDES
       
    23 #include <e32def.h>
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class CPbk2IconArray;
       
    27 
       
    28 // CLASS DECLARATION
       
    29 
       
    30 /**
       
    31  * Phonebook 2 UI extension icon support interface.
       
    32  * For adding icons to Phonebook 2 icon arrays.
       
    33  */
       
    34 class MPbk2UIExtensionIconSupport
       
    35     {
       
    36     public: // Interface
       
    37 
       
    38         /**
       
    39          * Destructor.
       
    40          */
       
    41         virtual ~MPbk2UIExtensionIconSupport()
       
    42                 {}
       
    43 
       
    44         /**
       
    45          * Appends icons to the icon array if the extension has defined one.
       
    46          *
       
    47          * @param aIconArray    The Phonebook 2 icon array
       
    48          *                      that can be extended.
       
    49          */
       
    50         virtual void AppendExtensionIconsL(
       
    51                 CPbk2IconArray& aIconArray ) = 0;
       
    52 
       
    53         /**
       
    54          * Refreshes extension icons in the icon array. Refresh is not done
       
    55          * if the extension doesn't have icons in the array.
       
    56          *
       
    57          * @param aIconArray    The Phonebook 2 icon array to be refreshed.
       
    58          */
       
    59         virtual void RefreshL(
       
    60                 CPbk2IconArray& aIconArray ) = 0;
       
    61     };
       
    62 
       
    63 #endif // MPBK2UIEXTENSIONICONSUPPORT_H
       
    64 
       
    65 // End of File