mmappfw_plat/mpx_base_view_plugins_api/inc/mpxakndialogplugin.h
changeset 0 a2952bb97e68
equal deleted inserted replaced
-1:000000000000 0:a2952bb97e68
       
     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:  MPX Avkon dialog plugin definition.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 
       
    20 #ifndef CMPXAKNDIALOGPLUGIN_H
       
    21 #define CMPXAKNDIALOGPLUGIN_H
       
    22 
       
    23 
       
    24 // INCLUDES
       
    25 #include "mpxviewplugin.h"
       
    26 
       
    27 
       
    28 // FORWARD DECLARATIONS
       
    29 class CAknDialog;
       
    30 
       
    31 
       
    32 // CLASS DECLARATION
       
    33 
       
    34 /**
       
    35  *  MPX Avkon dialog plugin definition.
       
    36  *
       
    37  *  @lib mpxviewplugin.lib
       
    38  */
       
    39 class CMPXAknDialogPlugin : public CMPXViewPlugin
       
    40     {
       
    41 public:
       
    42 
       
    43     /**
       
    44      * Destructor.
       
    45      *
       
    46      * @since S60 3.0
       
    47      */
       
    48     IMPORT_C virtual ~CMPXAknDialogPlugin();
       
    49 
       
    50 protected:
       
    51 
       
    52     /**
       
    53      * Interface method to construct Avkon dialog.
       
    54      *
       
    55      * @since S60 3.0
       
    56      * @return Pointer to a newly created Avkon dialog.
       
    57      */
       
    58     virtual CAknDialog* ConstructDialogL() = 0;
       
    59 
       
    60     /**
       
    61      * Return resource id of the Avkon dialog.
       
    62      *
       
    63      * @since S60 v.0
       
    64      * @return Dialog resource id.
       
    65      */
       
    66     virtual TInt ResourceId() = 0;
       
    67 
       
    68 // from base class CMPXViewPlugin
       
    69 
       
    70     /**
       
    71      * Interface method to create view.
       
    72      * From CMPXViewPlugin
       
    73      *
       
    74      * @since S60 3.0
       
    75      */
       
    76     IMPORT_C virtual void CreateViewL();
       
    77 
       
    78     /**
       
    79      * Interface method to destroy view.
       
    80      * From CMPXViewPlugin
       
    81      *
       
    82      * @since S60 3.0
       
    83      */
       
    84     IMPORT_C virtual void DestroyView();
       
    85 
       
    86     /**
       
    87      * Interface method to activate view.
       
    88      * From CMPXViewPlugin    
       
    89      *
       
    90      * @since S60 3.0
       
    91      * @param aParam Parameter required to activate the view.
       
    92      */
       
    93     IMPORT_C virtual void ActivateViewL( const TDesC* aParam = NULL );
       
    94     
       
    95     /**
       
    96      * Interface method to activate as default view.
       
    97      * Will not bring to foreground.
       
    98      * From CMPXViewPlugin     
       
    99      *
       
   100      * @since S60 3.0
       
   101      * @leave KErrNotSupported
       
   102      */
       
   103     IMPORT_C virtual void SetAsDefaultViewL();
       
   104 
       
   105     /**
       
   106      * Interface method to deactivate view.
       
   107      * From CMPXViewPlugin     
       
   108      *
       
   109      * @since S60 3.0
       
   110      */
       
   111     IMPORT_C virtual void DeactivateView();
       
   112 
       
   113 protected:  // data
       
   114 
       
   115     /**
       
   116      * Avkon dialog that associates with this plugin.
       
   117      */
       
   118     CAknDialog* iDialog;
       
   119     };
       
   120 
       
   121 #endif  // CMPXAKNDIALOGPLUGIN_H
       
   122 
       
   123 // End of File