idlehomescreen/examples/mcsexample/inc/MCSExampleDocument.h
branchRCL_3
changeset 102 ba63c83f4716
parent 93 b01126ce0bec
child 103 966d119a7e67
equal deleted inserted replaced
93:b01126ce0bec 102:ba63c83f4716
     1 /*
       
     2 * Copyright (c) 2010 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:
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef __MCSEXAMPLEDOCUMENT_h__
       
    19 #define __MCSEXAMPLEDOCUMENT_h__
       
    20 
       
    21 // INCLUDES
       
    22 #include <akndoc.h>
       
    23 
       
    24 // FORWARD DECLARATIONS
       
    25 class CMCSExampleAppUi;
       
    26 class CEikApplication;
       
    27 
       
    28 // CLASS DECLARATION
       
    29 
       
    30 /**
       
    31  * CMCSExampleDocument application class.
       
    32  * An instance of class CMCSExampleDocument is the Document part of the
       
    33  * AVKON application framework for the MCSExample example application.
       
    34  */
       
    35 class CMCSExampleDocument : public CAknDocument
       
    36     {
       
    37 public:
       
    38     // Constructors and destructor
       
    39 
       
    40     /**
       
    41      * NewL.
       
    42      * Two-phased constructor.
       
    43      * Construct a CMCSExampleDocument for the AVKON application aApp
       
    44      * using two phase construction, and return a pointer
       
    45      * to the created object.
       
    46      * @param aApp Application creating this document.
       
    47      * @return A pointer to the created instance of CMCSExampleDocument.
       
    48      */
       
    49     static CMCSExampleDocument* NewL(CEikApplication& aApp);
       
    50 
       
    51     /**
       
    52      * NewLC.
       
    53      * Two-phased constructor.
       
    54      * Construct a CMCSExampleDocument for the AVKON application aApp
       
    55      * using two phase construction, and return a pointer
       
    56      * to the created object.
       
    57      * @param aApp Application creating this document.
       
    58      * @return A pointer to the created instance of CMCSExampleDocument.
       
    59      */
       
    60     static CMCSExampleDocument* NewLC(CEikApplication& aApp);
       
    61 
       
    62     /**
       
    63      * ~CMCSExampleDocument
       
    64      * Virtual Destructor.
       
    65      */
       
    66     virtual ~CMCSExampleDocument();
       
    67 
       
    68 public:
       
    69     // Functions from base classes
       
    70 
       
    71     /**
       
    72      * CreateAppUiL
       
    73      * From CEikDocument, CreateAppUiL.
       
    74      * Create a CMCSExampleAppUi object and return a pointer to it.
       
    75      * The object returned is owned by the Uikon framework.
       
    76      * @return Pointer to created instance of AppUi.
       
    77      */
       
    78     CEikAppUi* CreateAppUiL();
       
    79 
       
    80 private:
       
    81     // Constructors
       
    82 
       
    83     /**
       
    84      * ConstructL
       
    85      * 2nd phase constructor.
       
    86      */
       
    87     void ConstructL();
       
    88 
       
    89     /**
       
    90      * CMCSExampleDocument.
       
    91      * C++ default constructor.
       
    92      * @param aApp Application creating this document.
       
    93      */
       
    94     CMCSExampleDocument(CEikApplication& aApp);
       
    95 
       
    96     };
       
    97 
       
    98 #endif // __MCSEXAMPLEDOCUMENT_h__
       
    99 // End of File