devicediagnostics/diagsuites/diagtoplevelsuiteplugin/inc/diagtoplevelsuiteplugin.h
changeset 18 7d11f9a6646f
parent 4 75a71fdb4c92
child 21 c707676bf59f
equal deleted inserted replaced
4:75a71fdb4c92 18:7d11f9a6646f
     1 /*
       
     2 * Copyright (c) 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:  This is the declaration of the Top-Level Suite Plugin class.
       
    15 *
       
    16 */
       
    17 
       
    18 
       
    19 #ifndef DIAGTOPLEVELSUITEPLUGIN_H
       
    20 #define DIAGTOPLEVELSUITEPLUGIN_H
       
    21 
       
    22 // System Include Files
       
    23 #include <DiagSuitePluginBase.h>            // CDiagSuitePluginBase
       
    24 
       
    25 /**
       
    26  *  Diagnostics Top-Level Suite Plugin
       
    27  *  This class defines the top-level suite plugin.  This plugin is container for
       
    28  *  all of the suites and plugins which belong to the highest level in the test
       
    29  *  hierarchy.
       
    30  *
       
    31  *  @lib diagpluginbase.lib
       
    32  *  @lib diagframework.lib
       
    33  *  @lib commonengine.lib
       
    34  */
       
    35 class CDiagTopLevelSuitePlugin : public CDiagSuitePluginBase
       
    36     {
       
    37 
       
    38 public: // New functions
       
    39 
       
    40     /**
       
    41      * Two-phased constructor.
       
    42      *
       
    43      * @return An instance of CDiagTopLevelSuitePlugin.
       
    44      */
       
    45     static MDiagPlugin* NewL( TAny* aInitParams );
       
    46 
       
    47     /**
       
    48     * Destructor.
       
    49     */
       
    50     ~CDiagTopLevelSuitePlugin();
       
    51 
       
    52 
       
    53 private: // New functions
       
    54 
       
    55     /**
       
    56      * The default constructor.
       
    57      */
       
    58     CDiagTopLevelSuitePlugin( CDiagPluginConstructionParam* aInitParams  );
       
    59 
       
    60     /**
       
    61      * Two-phased constructor.
       
    62      */
       
    63     void ConstructL();
       
    64 
       
    65 
       
    66 private: // From base class CDiagSuitePluginBase
       
    67 
       
    68     /**
       
    69     * @see CDiagSuitePluginBase::Visible()
       
    70     */
       
    71     virtual TBool IsVisible() const;
       
    72 
       
    73     /**
       
    74     * @see CDiagSuitePluginBase::GetPluginNameL
       
    75     */
       
    76     virtual HBufC* GetPluginNameL( TNameLayoutType aLayoutType ) const;
       
    77 
       
    78     /**
       
    79     * @see CDiagSuitePluginBase::Uid
       
    80     */
       
    81     virtual TUid Uid() const;
       
    82 
       
    83 
       
    84 private: // From base class CActive
       
    85     /**
       
    86     * Handle active object completion event
       
    87     */
       
    88     virtual void RunL();
       
    89 
       
    90     /**
       
    91     * Handle cancel
       
    92     */
       
    93     virtual void DoCancel();
       
    94 
       
    95     };
       
    96 
       
    97 #endif // DIAGTOPLEVELSUITEPLUGIN_H