locationtriggering/lbtmgmtui/inc/lbtmgmtplugin.h
branchRCL_3
changeset 44 2b4ea9893b66
parent 42 02ba3f1733c6
child 45 6b6920c56e2f
equal deleted inserted replaced
42:02ba3f1733c6 44:2b4ea9893b66
     1 /*
       
     2 * Copyright (c) 2006 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:  Location Triggering Management Plugin View's container
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef CLBTMGMTPLUGIN_H_
       
    19 #define CLBTMGMTPLUGIN_H_
       
    20 
       
    21 // System Includes
       
    22 #include <ConeResLoader.h>
       
    23 
       
    24 // User Includes
       
    25 #include "locsettingsui.h"
       
    26 
       
    27 // Classes referenced
       
    28 class MLocSettingsUiObserver;
       
    29 class CAknViewAppUi;
       
    30 class CLbtMgmtPluginView;
       
    31 
       
    32 // Constant Definition
       
    33 //Location Triggering Management plug-in RSC file name
       
    34 _LIT( KLbtMgmtUiResFileName, "lbtmgmtpluginview.rsc" );
       
    35 
       
    36 // Class Definition
       
    37 /**
       
    38  * Location Triggering Management plug-in.
       
    39  */
       
    40 class CLbtMgmtPlugin : public CLocSettingsUi
       
    41     {
       
    42     
       
    43     public: // Constructors and destructor
       
    44         
       
    45         /**
       
    46          * Symbian OS two-phased constructor
       
    47          *
       
    48          * @param aParam Generic parameter structure to the Settings UI plug-in
       
    49          * @return 
       
    50          */
       
    51         static CLbtMgmtPlugin* NewL( TAny* aParam );
       
    52     
       
    53         /**
       
    54          * Destructor.
       
    55          */
       
    56         ~CLbtMgmtPlugin();
       
    57  
       
    58         /**
       
    59          * Inherited from CSettingsUi
       
    60          * Launches the Settings UI
       
    61          *
       
    62          * @param aUiLaunchParams   Flags that define specific configuration of
       
    63          *                          if the Settings UI, that the user of the API
       
    64          *                          wants to launch. If more than one functionality
       
    65          *                          is requested then the various combinations
       
    66          *                          are to be ORed. The interpretation of these
       
    67          *                          flag values is a part of the understanding
       
    68          *                          between the API user and the Settings UI
       
    69          */
       
    70         void LaunchL( TInt      aUiLaunchParams );
       
    71 
       
    72         /**
       
    73          * Inherited from CSettingsUi
       
    74          * Closes the running Settings UI prematurely.
       
    75          */
       
    76         void Close();
       
    77 
       
    78         /**
       
    79          * Inherited from CSettingsUi
       
    80          * Method for getting caption of this plugin. This should be the 
       
    81          * localized name of the settings view to be shown in parent view.
       
    82          *
       
    83          * @param aCaption pointer to Caption variable
       
    84          */
       
    85         void GetCaptionL( TDes& aCaption ) const;
       
    86 
       
    87         /**
       
    88          * Inherited from CSettingsUi
       
    89          * Returns the priority of the UI module.
       
    90          * 
       
    91          * @return Priority of the Settings UI
       
    92          */
       
    93         TInt GetPriority();
       
    94          
       
    95     private:
       
    96         /**
       
    97          * C++ default constructor.
       
    98          */
       
    99         CLbtMgmtPlugin( MLocSettingsUiObserver&      aSettingsUiObserver,
       
   100                            CAknViewAppUi&               aAppUi );
       
   101 
       
   102         /**
       
   103          * Second phase constructor.
       
   104          */
       
   105         void ConstructL();
       
   106 
       
   107         /**
       
   108          * Opens the nearest localized resourcefile using aResourceLoader. 
       
   109          * aResourceLoader should be opened only once before closing it. 
       
   110          * Otherwise it will raise a panic. Therefore it is better to have 
       
   111          * multiple resource loaders.
       
   112          * 
       
   113          * @param aResourceFileName Drive and name of resource file in format 
       
   114          *                          <path>:<rsc_file_name>
       
   115          * @param aResourceLoader Resource loader for the resource. The loader 
       
   116          *                        must not be opened allready or it will raise 
       
   117          *                        a panic. It is caller's responsibility to 
       
   118          *                        close the resource loader after using the 
       
   119          *                        resource.
       
   120          */
       
   121         void OpenLocalizedResourceFileL( const TDesC&               aResourceFileName, 
       
   122                                                RConeResourceLoader& aResourceLoader );
       
   123                                                        
       
   124   
       
   125     private:
       
   126         /**
       
   127          * Resource Loader handle for handling Location Triggering Management settings' 
       
   128          * specific resources
       
   129          */
       
   130         RConeResourceLoader             iResourceLoader;
       
   131             
       
   132         /**
       
   133          * Location Triggering Management view
       
   134          * Owns
       
   135          */
       
   136         CLbtMgmtPluginView*      iView;
       
   137         
       
   138         /**
       
   139          * Location Triggering Management view Id
       
   140          */
       
   141         TUid                        iViewId;
       
   142     };
       
   143 
       
   144 #endif // CLBTMGMTPLUGIN_H_