messagingappbase/mcesettings/mcesettingsgsplugin/inc/MceSettingsGSPlugin.h
changeset 0 72b543305e3a
equal deleted inserted replaced
-1:000000000000 0:72b543305e3a
       
     1 /*
       
     2 * Copyright (c) 2006-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:   Defines class for Messaging Settings GS plugin
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef MCESETTINGSGSPLUGIN_H
       
    21 #define MCESETTINGSGSPLUGIN_H
       
    22 
       
    23 // Includes
       
    24 #include <gsbaseview.h>         // CGSBaseView
       
    25 
       
    26 // Classes referenced
       
    27 class CMuiuLock;
       
    28 class CGSBaseView;
       
    29 class CAknLocalScreenClearer;
       
    30 
       
    31 // Constants
       
    32 
       
    33 /**
       
    34 * This UID is used for both the view UID and the ECOM plugin implementation
       
    35 * UID.
       
    36 */
       
    37 const TUid KGSMceSettingsGSPluginUid = { 0x10282EE0 };
       
    38 
       
    39 // CLASS DECLARATION
       
    40 
       
    41 /**
       
    42 * Header of CMceSettingsGSPlugin which implements the CGSPluginInterface.
       
    43 */
       
    44 class CMceSettingsGSPlugin :
       
    45     public CGSBaseView,
       
    46     public MCoeViewDeactivationObserver
       
    47     {
       
    48     public:
       
    49         /**
       
    50         * NewL
       
    51         * Symbian OS two-phased constructor
       
    52         * @return CMceSettingsGSPlugin*, self pointer
       
    53         */
       
    54         static CMceSettingsGSPlugin* NewL( TAny* aAppUi );
       
    55 
       
    56         /**
       
    57         * Destructor
       
    58         */
       
    59         virtual ~CMceSettingsGSPlugin();
       
    60 
       
    61     private: // Functions from base classes
       
    62 
       
    63         /**
       
    64         * From CAknView, returns the views id.
       
    65         * See base class.
       
    66         * @since 5.0
       
    67         */
       
    68         TUid Id() const;
       
    69 
       
    70         /**
       
    71         * From CAknView
       
    72         * See base class.
       
    73         * @since 5.0
       
    74         */
       
    75         void DoActivateL( const TVwsViewId& aPrevViewId,
       
    76                           TUid aCustomMessageId,
       
    77                           const TDesC8& aCustomMessage );
       
    78 
       
    79         /**
       
    80         * From CAknView Deactivate this view
       
    81         * See base class.
       
    82         * @since 5.0
       
    83         */
       
    84         void DoDeactivate();
       
    85 
       
    86          /**
       
    87         * From MEikCommandObserver, handles the menu based commands.
       
    88         * See base class.
       
    89         * @since 5.0
       
    90         */
       
    91         void HandleCommandL( TInt aCommand );
       
    92 
       
    93         /**
       
    94         * From CGSBaseView
       
    95         * See base class.
       
    96         * @since 5.0
       
    97         */
       
    98         void NewContainerL();
       
    99 
       
   100         /**
       
   101         * Handles OK key press.
       
   102         * @since 5.0
       
   103         */
       
   104         void HandleListBoxSelectionL();
       
   105 
       
   106         /**
       
   107         * From CGSPluginInterface
       
   108         * See base class.
       
   109         * @since 5.0
       
   110         */
       
   111         void GetCaptionL( TDes& aCaption ) const;
       
   112 
       
   113         /**
       
   114         * From CGSPluginInterface
       
   115         * See base class.
       
   116         */
       
   117         TInt PluginProviderCategory() const;
       
   118 
       
   119         /**
       
   120         * From CGSPluginInterface
       
   121         * See base class.
       
   122         * @since 5.0
       
   123         */
       
   124         CGulIcon* CreateIconL( const TUid aIconType );
       
   125 
       
   126         /**
       
   127         * From MEikMenuObserver
       
   128         * See base class.
       
   129         */
       
   130         void DynInitMenuPaneL( TInt aResourceId, CEikMenuPane* aMenuPane );
       
   131 
       
   132         /**
       
   133         * From MCoeViewDeactivationObserver
       
   134         * See base class.
       
   135         */
       
   136         void HandleViewDeactivation (
       
   137             const TVwsViewId& aViewIdToBeDeactivated,
       
   138             const TVwsViewId& aNewlyActivatedViewId );
       
   139 
       
   140         /**
       
   141         * From MEikListBoxObserver
       
   142         * See basc class
       
   143         */
       
   144         virtual void HandleListBoxEventL(CEikListBox* aListBox, TListBoxEvent aEventType );
       
   145         
       
   146     private: // Constructors
       
   147 
       
   148         /**
       
   149         * CMceSettingsGSPlugin
       
   150         */
       
   151         CMceSettingsGSPlugin();
       
   152 
       
   153         /**
       
   154         * Symbian OS default constructor.
       
   155         */
       
   156         void ConstructL();
       
   157 
       
   158     private: // Data
       
   159         CMuiuLock*                      iSettingsLock;
       
   160         CAknLocalScreenClearer*         iLocalScreenClearer;
       
   161     };
       
   162 
       
   163 #endif    // MCESETTINGSGSPLUGIN_H
       
   164 // End of File