iptel_plat/csc_settingsui_api/inc/cscsettingsui.h
branchRCL_3
changeset 21 f742655b05bf
parent 20 65a3ef1d5bd0
child 22 d38647835c2e
equal deleted inserted replaced
20:65a3ef1d5bd0 21:f742655b05bf
     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:  Declarition of CSCSettingsUi API.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef C_CSCSETTINGSUI_H
       
    20 #define C_CSCSETTINGSUI_H
       
    21 
       
    22 #include <e32def.h>
       
    23 #include <e32base.h>
       
    24 
       
    25 class CEikonEnv;
       
    26 class CCSCSettingsUiImpl;
       
    27 class MCoeView;
       
    28 
       
    29 /**
       
    30  *  CSCSettingsUi class
       
    31  *  Implements CSCSettingsUi API methods.
       
    32  *
       
    33  *  @lib CSCSettingsUi.lib
       
    34  *  @since S60 v3.2
       
    35  */
       
    36 NONSHARABLE_CLASS( CCSCSettingsUi ) : public CBase
       
    37     {
       
    38     public:
       
    39         
       
    40         /**
       
    41          * Two-phased constructor.
       
    42          */
       
    43         IMPORT_C static CCSCSettingsUi* NewL( CEikonEnv& aEikEnv );
       
    44  
       
    45         
       
    46         /**
       
    47          * Destructor.
       
    48          */
       
    49         virtual ~CCSCSettingsUi();
       
    50        
       
    51    
       
    52         /**
       
    53          * Initializes Converged Service Configurator Settings UI. 
       
    54          *  
       
    55          * @param   aReturnViewId   Identifier of the view where to return with 
       
    56          *                          "back" key.
       
    57          * @param   aServiceId      Service settings identifier.
       
    58          * @param   aDefaultAppView The view to set as the default for client
       
    59          *                          application. If NULL, settings ui view
       
    60          *                          is set as the default view for the 
       
    61          *                          application.
       
    62          * @since   S60 v5.1
       
    63          */
       
    64         IMPORT_C void InitializeL( 
       
    65             const TUid& aReturnViewId, 
       
    66             TUint aServiceId,
       
    67             const MCoeView* aDefaultAppView );
       
    68         
       
    69         /**
       
    70          * Launches Converged Service Configurator Settings UI with parameters
       
    71          * given at initialization. 
       
    72          * 
       
    73          * @since   S60 v3.2
       
    74          * @pre     Initialization is done at least once.
       
    75          */
       
    76         IMPORT_C void LaunchSettingsUiL() const;
       
    77         
       
    78     private:
       
    79 
       
    80         CCSCSettingsUi();
       
    81 
       
    82         void ConstructL( CEikonEnv& aEikEnv );
       
    83             
       
    84     private: // Data
       
    85     
       
    86         /**
       
    87          * Implementation of the CSC Settings UI.
       
    88          * Own.
       
    89          */
       
    90         CCSCSettingsUiImpl* iImpl;
       
    91 
       
    92 #ifdef _DEBUG
       
    93     friend class UT_cscsettingsui;
       
    94 #endif        
       
    95     };
       
    96 
       
    97 #endif  // C_CSCSETTINGSUI_H
       
    98