contacts_plat/phonebook_2_ui_extension_api/inc/MPbk2AppUiExtension.h
branchRCL_3
changeset 63 f4a778e096c2
child 64 c1e8ba0c2b16
equal deleted inserted replaced
62:5b6f26637ad3 63: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 application UI UI extension interface.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef MPBK2APPUIEXTENSION_H
       
    20 #define MPBK2APPUIEXTENSION_H
       
    21 
       
    22 // INCLUDES
       
    23 #include <MPbk2UiReleasable.h>
       
    24 
       
    25 // FORWARD DECLARATIONS
       
    26 class MPbk2StartupMonitor;
       
    27 class CAknTabGroup;
       
    28 class CPbk2IconInfoContainer;
       
    29 class CPbk2ViewNode;
       
    30 
       
    31 // CLASS DECLARATION
       
    32 
       
    33 /**
       
    34  * Phonebook 2 application UI UI extension interface.
       
    35  * Application UI extensions can be used to monitor startup
       
    36  * procedure and to maintain tab groups.
       
    37  */
       
    38 class MPbk2AppUiExtension :  public MPbk2UiReleasable
       
    39     {
       
    40     public: // Interface
       
    41 
       
    42         /**
       
    43          * Called by the Phonebook 2 startup monitor when
       
    44          * the application startup begins.
       
    45          *
       
    46          * NOTE: The extension MUST always call either HandleStartupComplete
       
    47          *       or HandleStartupFailed. If the extension don't need to monitor
       
    48          *       events it can do the call back in it's implementation of 
       
    49          *       ExtensionStartupL.
       
    50          *
       
    51          * @param aStartupMonitor   Startup monitor.
       
    52          */
       
    53         virtual void ExtensionStartupL(
       
    54                 MPbk2StartupMonitor& aStartupMonitor ) = 0;
       
    55 
       
    56         /**
       
    57          * Allows extensions to add tab groups dynamically.
       
    58          *
       
    59          * @param aNode         View graph node.
       
    60          * @param aAknTabGroup  Avkon tab group.
       
    61          * @param aTabIcons     Tab icon info container.
       
    62          * @param aViewCount    Amount of views in the tab.
       
    63          */
       
    64         virtual void ApplyDynamicPluginTabGroupContainerChangesL(
       
    65                 const CPbk2ViewNode& aNode, 
       
    66                 CAknTabGroup& aAknTabGroup,
       
    67                 CPbk2IconInfoContainer& aTabIcons,
       
    68                 TInt aViewCount ) = 0;
       
    69 
       
    70         /**
       
    71          * Returns an extension point for this interface or NULL.
       
    72          *
       
    73          * @param aExtensionUid     Extension UID.
       
    74          * @return  Extension point.
       
    75          */
       
    76         virtual TAny* AppUiExtensionExtension(
       
    77                 TUid /*aExtensionUid*/ )
       
    78             {
       
    79             return NULL;
       
    80             }
       
    81     };
       
    82 
       
    83 #endif // MPBK2APPUIEXTENSION_H
       
    84 
       
    85 // End of File