creator/inc/creator_document.h
changeset 0 d6fe6244b863
equal deleted inserted replaced
-1:000000000000 0:d6fe6244b863
       
     1 /*
       
     2 * Copyright (c) 2008 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 
       
    19 
       
    20 
       
    21 #ifndef __CREATOR_DOCUMENT_H__
       
    22 #define __CREATOR_DOCUMENT_H__
       
    23 
       
    24 
       
    25 #include <AknDoc.h>
       
    26 
       
    27 // Forward references
       
    28 class CCreatorAppUi;
       
    29 class CEikApplication;
       
    30 
       
    31 
       
    32 /*! 
       
    33   @class CCreatorDocument
       
    34   
       
    35   @discussion An instance of class CCreatorDocument is the Document part of the AVKON
       
    36   application framework for the Creator example application
       
    37   */
       
    38 class CCreatorDocument : public CAknDocument
       
    39     {
       
    40 public:
       
    41 
       
    42 /*!
       
    43   @function NewL
       
    44   
       
    45   @discussion Construct a CCreatorDocument for the AVKON application aApp 
       
    46   using two phase construction, and return a pointer to the created object
       
    47   @param aApp application creating this document
       
    48   @result a pointer to the created instance of CCreatorDocument
       
    49   */
       
    50     static CCreatorDocument* NewL(CEikApplication& aApp);
       
    51 
       
    52 /*!
       
    53   @function NewLC
       
    54   
       
    55   @discussion Construct a CCreatorDocument for the AVKON application aApp 
       
    56   using two phase construction, and return a pointer to the created object
       
    57   @param aApp application creating this document
       
    58   @result a pointer to the created instance of CCreatorDocument
       
    59   */
       
    60     static CCreatorDocument* NewLC(CEikApplication& aApp);
       
    61 
       
    62 /*!
       
    63   @function ~CCreatorDocument
       
    64   
       
    65   @discussion Destroy the object and release all memory objects
       
    66   */
       
    67     ~CCreatorDocument();
       
    68 
       
    69 /*!
       
    70   @function CreateAppUiL 
       
    71   
       
    72   @discussion Create a CCreatorAppUi object and return a pointer to it
       
    73   @result a pointer to the created instance of the AppUi created
       
    74   */
       
    75     CEikAppUi* CreateAppUiL();
       
    76 private:
       
    77 
       
    78 /*!
       
    79   @function ConstructL
       
    80   
       
    81   @discussion Perform the second phase construction of a CCreatorDocument object
       
    82   */
       
    83     void ConstructL();
       
    84 
       
    85 /*!
       
    86   @function CCreatorDocument
       
    87   
       
    88   @discussion Perform the first phase of two phase construction 
       
    89   @param aApp application creating this document
       
    90   */
       
    91     CCreatorDocument(CEikApplication& aApp);
       
    92 
       
    93     };
       
    94 
       
    95 
       
    96 #endif // __CREATOR_DOCUMENT_H__