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