commsconfig/cscapplicationui/inc/cscdocument.h
changeset 0 a4daefaec16c
equal deleted inserted replaced
-1:000000000000 0:a4daefaec16c
       
     1 /*
       
     2 * Copyright (c) 2007-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:  CSC Applications Document
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_CSCDOCUMENT_H
       
    20 #define C_CSCDOCUMENT_H
       
    21 
       
    22 #include <AknDoc.h>
       
    23 
       
    24 class CCSCAppUi;
       
    25 class CEikAppUi;
       
    26 class CEikApplication;
       
    27 class CCSCEngServicePluginHandler;
       
    28 class CCSCEngUiExtensionPluginHandler;
       
    29 
       
    30 
       
    31 /**
       
    32  *  An instance of class CCSCDocument
       
    33  *  The Document part of AVKON application framework for CSC application
       
    34  *
       
    35  *  @lib
       
    36  *  @since S60 v3.2
       
    37  */
       
    38 NONSHARABLE_CLASS( CCSCDocument ) : public CAknDocument
       
    39     {
       
    40     public:
       
    41         
       
    42         /**
       
    43          * Two-phased constructor.
       
    44          * @param aApp CEikApplication
       
    45          */
       
    46         static CCSCDocument* NewL( CEikApplication& aApp );
       
    47         
       
    48         
       
    49         /**
       
    50          * Two-phased constructor.
       
    51          * @param aApp CEikApplication
       
    52          */
       
    53         static CCSCDocument* NewLC( CEikApplication& aApp );
       
    54 
       
    55 
       
    56         /**
       
    57          * Destructor
       
    58          */
       
    59         virtual ~CCSCDocument();
       
    60 
       
    61         
       
    62         /**
       
    63          * Transfers ownership to document.
       
    64          * 
       
    65          * @since S60 v3.2
       
    66          * @param aServicePluginHandler for handle to be transferred
       
    67          * @param aUiExtensionPluginHandler for handle to be transferred
       
    68          */
       
    69         void SetOwnershipOfPluginHandlers( 
       
    70             CCSCEngServicePluginHandler* aServicePluginHandler,
       
    71             CCSCEngUiExtensionPluginHandler* aUiExtensionPluginHandler );  
       
    72         
       
    73         
       
    74         /**
       
    75          * Return reference to service plug-in handler
       
    76          * 
       
    77          * @since S60 v3.0
       
    78          * @return reference to service plug-in handler
       
    79          */
       
    80         CCSCEngServicePluginHandler& ServicePluginHandler();
       
    81         
       
    82         
       
    83         // from base call CAknDocument
       
    84 
       
    85         /**
       
    86          * From CAknDocument 
       
    87          * Create a CCSCAppUi object and return a pointer to it
       
    88          *
       
    89          * @return CEikAppUi A pointer to the created instance of the
       
    90          *                   AppUi created
       
    91          */
       
    92         CEikAppUi* CreateAppUiL();
       
    93         
       
    94         /**
       
    95          * From CAknDocument 
       
    96          * Hides icon from task list
       
    97          * 
       
    98          * @param aWgName window group name
       
    99          */
       
   100         void UpdateTaskNameL( CApaWindowGroupName* aWgName );
       
   101 
       
   102     private:
       
   103 
       
   104         void ConstructL();
       
   105 
       
   106         CCSCDocument( CEikApplication& aApp );
       
   107     
       
   108     private: //data
       
   109         
       
   110         /**
       
   111          * Handle to CSC ServicePluginHandler.
       
   112          * Own.
       
   113          */
       
   114         CCSCEngServicePluginHandler* iServicePluginHandler;
       
   115         
       
   116         /**
       
   117          * Handle to CSC UiExtensionPluginHandler.
       
   118          * Own.
       
   119          */
       
   120         CCSCEngUiExtensionPluginHandler* iUiExtensionPluginHandler;
       
   121         
       
   122 #ifdef _DEBUG
       
   123     friend class UT_CSC;
       
   124 #endif
       
   125         
       
   126     };
       
   127 
       
   128 #endif // C_CSCDOCUMENT_H