imstutils/imconversationview/imcvuiapp/inc/cimcvappdocument.h
changeset 0 5e5d6b214f4f
equal deleted inserted replaced
-1:000000000000 0:5e5d6b214f4f
       
     1 /*
       
     2 * Copyright (c) 2007-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:  document part of avkon
       
    15 *
       
    16 */
       
    17 
       
    18 #ifndef CIMCVAPPDOCUMENT_H
       
    19 #define CIMCVAPPDOCUMENT_H
       
    20 
       
    21 
       
    22 #include <AknDoc.h>
       
    23 #include <apgwgnam.h>
       
    24 // Forward references
       
    25 class CIMCVAppUi;
       
    26 class CEikApplication;
       
    27 class CEikAppUi;
       
    28 
       
    29 /*! 
       
    30   @class CIMCVAppDocument
       
    31   
       
    32   @discussion An instance of class CIMCVAppDocument is the Document part of the AVKON
       
    33   application framework for the conversationview example application
       
    34   */
       
    35 class CIMCVAppDocument : public CAknDocument
       
    36     {
       
    37 public:
       
    38 
       
    39 /*!
       
    40   @function NewL
       
    41   
       
    42   @discussion Construct a CIMCVAppDocument for the AVKON application aApp 
       
    43   using two phase construction, and return a pointer to the created object
       
    44   @param aApp application creating this document
       
    45   @result a pointer to the created instance of CIMCVAppDocument
       
    46   */
       
    47     static CIMCVAppDocument* NewL(CEikApplication& aApp);
       
    48 
       
    49 /*!
       
    50   @function NewLC
       
    51   
       
    52   @discussion Construct a CIMCVAppDocument for the AVKON application aApp 
       
    53   using two phase construction, and return a pointer to the created object
       
    54   @param aApp application creating this document
       
    55   @result a pointer to the created instance of CIMCVAppDocument
       
    56   */
       
    57     static CIMCVAppDocument* NewLC(CEikApplication& aApp);
       
    58 
       
    59 /*!
       
    60   @function ~CIMCVAppDocument
       
    61   
       
    62   @discussion Destroy the object and release all memory objects
       
    63   */
       
    64     ~CIMCVAppDocument();
       
    65 
       
    66 public: // from CAknDocument
       
    67 /*!
       
    68   @function CreateAppUiL 
       
    69   
       
    70   @discussion Create a CIMCVAppUi object and return a pointer to it
       
    71   @result a pointer to the created instance of the AppUi created
       
    72   */
       
    73     CEikAppUi* CreateAppUiL();
       
    74     
       
    75  /**
       
    76     * This method makes an application hidden so that it is not visible
       
    77     * for example in Applications list and FastSwap window.
       
    78     * @param aWgName ,aWgName
       
    79     * @return void        
       
    80     */
       
    81     void UpdateTaskNameL( CApaWindowGroupName* aWgName );
       
    82 
       
    83 private:
       
    84 
       
    85 /*!
       
    86   @function ConstructL
       
    87   
       
    88   @discussion Perform the second phase construction of a CIMCVAppDocument object
       
    89   */
       
    90     void ConstructL();
       
    91 
       
    92 /*!
       
    93   @function CIMCVAppDocument
       
    94   
       
    95   @discussion Perform the first phase of two phase construction 
       
    96   @param aApp application creating this document
       
    97   */
       
    98     CIMCVAppDocument(CEikApplication& aApp);
       
    99 
       
   100     };
       
   101 
       
   102 
       
   103 #endif // CIMCVAPPDOCUMENT_H