Nokia N97 SDK
Example Applications Guide

HsWidgetDocument.h

00001 /*
00002  ============================================================================
00003  Name           : HsWidgetDocument.h
00004  Author   : 
00005  Copyright   : This material, including documentation and any related computer
00006           programs, is protected by copyright controlled by Nokia Corporation.
00007  Description : Declares document class for application.
00008  ============================================================================
00009  */
00010 
00011 #ifndef __HSWIDGETDOCUMENT_H__
00012 #define __HSWIDGETDOCUMENT_H__
00013 
00014 // INCLUDES
00015 #include <akndoc.h>
00016 
00017 // FORWARD DECLARATIONS
00018 class CHsWidgetAppUi;
00019 class CEikApplication;
00020 
00021 // CLASS DECLARATION
00022 
00023 /**
00024  * CHsWidgetDocument application class.
00025  * An instance of class CHsWidgetDocument is the Document part of the
00026  * AVKON application framework for the HsWidget example application.
00027  */
00028 class CHsWidgetDocument : public CAknDocument
00029         {
00030 public:
00031         // Constructors and destructor
00032 
00033         /**
00034          * NewL.
00035          * Two-phased constructor.
00036          * Constructs a CHsWidgetDocument for the AVKON application aApp
00037          * using two phase construction, and returns a pointer
00038          * to the created object.
00039          * @param aApp Application creating this document.
00040          * @return A pointer to the created instance of CHsWidgetDocument.
00041          */
00042         static CHsWidgetDocument* NewL(CEikApplication& aApp);
00043 
00044         /**
00045          * NewLC.
00046          * Two-phased constructor.
00047          * Constructs a CHsWidgetDocument for the AVKON application aApp
00048          * using two phase construction and returns a pointer
00049          * to the created object.
00050          * @param aApp Application creating this document.
00051          * @return A pointer to the created instance of CHsWidgetDocument.
00052          */
00053         static CHsWidgetDocument* NewLC(CEikApplication& aApp);
00054 
00055         /**
00056          * ~CHsWidgetDocument
00057          * Virtual Destructor.
00058          */
00059         virtual ~CHsWidgetDocument();
00060 
00061 public:
00062         // Functions from base classes
00063 
00064         /**
00065          * CreateAppUiL
00066          * From CEikDocument, CreateAppUiL.
00067          * Create a CHsWidgetAppUi object and return a pointer to it.
00068          * The returned object is owned by the Uikon framework.
00069          * @return Pointer to created instance of AppUi.
00070          */
00071         CEikAppUi* CreateAppUiL();
00072 
00073 private:
00074         // Constructors
00075 
00076         /**
00077          * ConstructL
00078          * 2nd phase constructor.
00079          */
00080         void ConstructL();
00081 
00082         /**
00083          * CHsWidgetDocument.
00084          * C++ default constructor.
00085          * @param aApp Application creating this document.
00086          */
00087         CHsWidgetDocument(CEikApplication& aApp);
00088 
00089         };
00090 
00091 #endif // __HSWIDGETDOCUMENT_H__
00092 // End of File

© Nokia 2009

Back to top