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