Nokia N97 SDK
Example Applications Guide

helpexampledocument.h

00001 /*
00002 * ==============================================================================
00003 *  Name        : helpexampledocument.h
00004 *  Part of     : Help example
00005 *  Interface   :
00006 *  Description :
00007 *  Version     :
00008 *
00009 *  Copyright (c) 2004 - 2006 Nokia Corporation.
00010 *  This material, including documentation and any related
00011 *  computer programs, is protected by copyright controlled by
00012 *  Nokia Corporation.
00013 * ==============================================================================
00014 */
00015 
00016 #ifndef __HELPEXAMPLE_DOCUMENT_H__
00017 #define __HELPEXAMPLE_DOCUMENT_H__
00018 
00019 // INCLUDES
00020 #include <akndoc.h>
00021 
00022 // FORWARD DECLARATIONS
00023 
00024 class CHelpExampleAppUi;
00025 class CEikApplication;
00026 
00027 // CLASS DECLARATION
00028 
00029 /**
00030 * CHelpExampleDocument
00031 * An instance of class CHelpExampleDocument is the Document part of the AVKON
00032 * application framework for the HelpExample example application
00033 */
00034 
00035 class CHelpExampleDocument : public CAknDocument
00036     {
00037         public: // Constructors and destructor.
00038 
00039             /**
00040             * NewL()
00041             * Construct a CHelpExampleDocument for the AVKON application aApp 
00042             * using two phase construction, and return a pointer to 
00043             * the created object
00044             * @param aApp Application creating this document
00045             * @return A pointer to the created instance of CHelpExampleDocument
00046             */
00047             static CHelpExampleDocument* NewL( CEikApplication& aApp );
00048 
00049             /**
00050             * NewLC()
00051             * Construct a CHelpExampleDocument for the AVKON application aApp 
00052             * using two phase construction, and return a pointer to 
00053             * the created object
00054             * @param aApp Application creating this document
00055             * @return A pointer to the created instance of CHelpExampleDocument
00056             */
00057             static CHelpExampleDocument* NewLC( CEikApplication& aApp );
00058 
00059             /**
00060             * ~CHelpExampleDocument()
00061             * Destroy the object
00062             */
00063             virtual ~CHelpExampleDocument();
00064 
00065         public: // from CAknDocument
00066 
00067             /**
00068             * CreateAppUiL()
00069             * Create a CHelpExampleAppUi object and return a pointer to it
00070             * @return A pointer to the created instance of the AppUi created
00071             */
00072             CEikAppUi* CreateAppUiL();
00073 
00074         private:    // Constructors
00075 
00076             /**
00077             * ConstructL()
00078             * Perform the second phase construction of a CHelpExampleDocument object
00079             */
00080 
00081             void ConstructL();
00082 
00083             /**
00084             * CHelpExampleDocument()
00085             * Perform the first phase of two phase construction 
00086             * @param aApp Application creating this document
00087             */
00088             CHelpExampleDocument( CEikApplication& aApp );
00089 
00090     };
00091 
00092 
00093 #endif // __HELPEXAMPLE_DOCUMENT_H__
00094 
00095 // End of File

© Nokia 2009

Back to top