mobilemessaging/smum/inc/simdlgplugininterface.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 /*
       
     2 * Copyright (c) 2002-2009 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:  
       
    15 *     Sim Dialog plugin interface
       
    16 *
       
    17 */
       
    18 
       
    19 #ifndef __SIMDLG_PLUGIN_INTERFACE_H__
       
    20 #define __SIMDLG_PLUGIN_INTERFACE_H__
       
    21 
       
    22 //INCLUDES
       
    23 #include <simdlgplugin.h>
       
    24 
       
    25 // CLASS DECLARATION
       
    26 /**
       
    27  * Class is used to instantiate the required plugin.
       
    28  * Acts as interface to all Plugins.
       
    29  */
       
    30 
       
    31 class CSimDlgPluginInterface : public CBase 
       
    32     {
       
    33 public:
       
    34 
       
    35     /** 
       
    36      * NewL
       
    37      * Symbian OS 2 phased constructor
       
    38      * 
       
    39      * @param aSmsMtmUi CSmsMtmUi
       
    40      * @param aSession CMsvSession 
       
    41      *
       
    42      * @return	A pointer to the created instance of CSimDlgPluginInterface.
       
    43      */
       
    44     static CSimDlgPluginInterface* NewL(CSmsMtmUi&  aSmsMtmUi, CMsvSession& aSession);
       
    45 
       
    46     /** 
       
    47      * NewLC
       
    48      * Symbian OS 2 phased constructor
       
    49      * 
       
    50      * @param aSmsMtmUi CSmsMtmUi
       
    51      * @param aSession CMsvSession 
       
    52      *
       
    53      * @return	A pointer to the created instance of CSimDlgPluginInterface.
       
    54      */
       
    55     static CSimDlgPluginInterface* NewLC(CSmsMtmUi&  aSmsMtmUi, CMsvSession& aSession);
       
    56 
       
    57     /**
       
    58      * Destructor.
       
    59      */      
       
    60     virtual ~CSimDlgPluginInterface();
       
    61 
       
    62     /**
       
    63      * UnloadPlugIn     
       
    64      */
       
    65     void UnloadPlugIn(); 
       
    66 
       
    67     /**
       
    68      * LaunchL
       
    69      * Forwards the request to the plugin instance ,
       
    70      * Launches the sim dialog
       
    71      */
       
    72     void  LaunchL();
       
    73 
       
    74 private: 
       
    75 
       
    76     /** 
       
    77      * Performs the first phase of two phase construction.
       
    78      */
       
    79     CSimDlgPluginInterface();  
       
    80 
       
    81     /** 
       
    82      * Symbian OS 2 phased constructor.
       
    83      * 
       
    84      * @param aSmsMtmUi CSmsMtmUi
       
    85      * @param aSession CMsvSession 
       
    86      *
       
    87      */
       
    88     void ConstructL(CSmsMtmUi&  aSmsMtmUi, CMsvSession& aSession);
       
    89 
       
    90     /**
       
    91      * InstantiatePluginL
       
    92      * Instantiates the required plug-ins known by the ecom framework.
       
    93      *
       
    94      * @param aSmsMtmUi CSmsMtmUi
       
    95      * @param aSession CMsvSession 
       
    96      */
       
    97     void InstantiatePluginL(CSmsMtmUi&  aSmsMtmUi, CMsvSession& aSession);
       
    98 
       
    99     /**
       
   100      * ListAllImplementationsL
       
   101      * Lists all implementations which satisfy this ecom interface
       
   102      * 
       
   103      * @param aImplInfoArray On return, contains the list of available implementations
       
   104      */   
       
   105     inline void ListAllImplementationsL( 
       
   106             RImplInfoPtrArray& aImplInfoArray )
       
   107         {
       
   108         REComSession::ListImplementationsL( 
       
   109                 KSimDialogPluginInterfaceUid, 
       
   110                 aImplInfoArray );
       
   111         }
       
   112 
       
   113 
       
   114 private: 
       
   115 
       
   116     /**
       
   117      * iDtor_ID_Key
       
   118      * Unique Key, handle by ECom plugin
       
   119      */
       
   120     TUid iDtor_ID_Key;
       
   121 
       
   122     /**
       
   123      * iSimDlgPlugin
       
   124      * plugin instance
       
   125      */
       
   126     CSimDlgPlugin* iSimDlgPlugin; 
       
   127 
       
   128     };
       
   129 
       
   130 #endif // __SIMDLG_PLUGIN_INTERFACE_H__
       
   131 
       
   132 //End of File