|
1 /* |
|
2 ============================================================================ |
|
3 Name : NPRDocument.h |
|
4 Author : John Kern |
|
5 |
|
6 Copyright (c) 2009 Symbian Foundation Ltd |
|
7 This component and the accompanying materials are made available |
|
8 under the terms of the License "Eclipse Public License v1.0" |
|
9 which accompanies this distribution, and is available |
|
10 at the URL "http://www.eclipse.org/legal/epl-v10.html". |
|
11 |
|
12 Initial Contributors: |
|
13 - Symbian Foundation Ltd - initial contribution. |
|
14 |
|
15 Contributors: |
|
16 - John Kern |
|
17 - Symsource |
|
18 |
|
19 Description : Declares document class for application. |
|
20 ============================================================================ |
|
21 */ |
|
22 |
|
23 |
|
24 #ifndef __NPR_DOCUMENT_H__ |
|
25 #define __NPR_DOCUMENT_H__ |
|
26 |
|
27 // INCLUDES |
|
28 #include <akndoc.h> |
|
29 |
|
30 #include "NPRStory.h" |
|
31 |
|
32 // FORWARD DECLARATIONS |
|
33 class CNPRAppUi; |
|
34 class CEikApplication; |
|
35 |
|
36 // CLASS DECLARATION |
|
37 |
|
38 /** |
|
39 * CNPRDocument application class. |
|
40 * An instance of class CNPRDocument is the Document part of the |
|
41 * AVKON application framework for the NPR example application. |
|
42 */ |
|
43 class CNPRDocument : public CAknDocument |
|
44 { |
|
45 public: |
|
46 // Constructors and destructor |
|
47 |
|
48 /** |
|
49 * NewL. |
|
50 * Two-phased constructor. |
|
51 * Construct a CNPRDocument for the AVKON application aApp |
|
52 * using two phase construction, and return a pointer |
|
53 * to the created object. |
|
54 * @param aApp Application creating this document. |
|
55 * @return A pointer to the created instance of CNPRDocument. |
|
56 */ |
|
57 static CNPRDocument* NewL(CEikApplication& aApp); |
|
58 |
|
59 /** |
|
60 * NewLC. |
|
61 * Two-phased constructor. |
|
62 * Construct a CNPRDocument for the AVKON application aApp |
|
63 * using two phase construction, and return a pointer |
|
64 * to the created object. |
|
65 * @param aApp Application creating this document. |
|
66 * @return A pointer to the created instance of CNPRDocument. |
|
67 */ |
|
68 static CNPRDocument* NewLC(CEikApplication& aApp); |
|
69 |
|
70 /** |
|
71 * ~CNPRDocument |
|
72 * Virtual Destructor. |
|
73 */ |
|
74 virtual ~CNPRDocument(); |
|
75 |
|
76 public: |
|
77 // Functions from base classes |
|
78 |
|
79 /** |
|
80 * CreateAppUiL |
|
81 * From CEikDocument, CreateAppUiL. |
|
82 * Create a CNPRAppUi object and return a pointer to it. |
|
83 * The object returned is owned by the Uikon framework. |
|
84 * @return Pointer to created instance of AppUi. |
|
85 */ |
|
86 CEikAppUi* CreateAppUiL(); |
|
87 |
|
88 private: |
|
89 // Constructors |
|
90 |
|
91 /** |
|
92 * ConstructL |
|
93 * 2nd phase constructor. |
|
94 */ |
|
95 void ConstructL(); |
|
96 |
|
97 /** |
|
98 * CNPRDocument. |
|
99 * C++ default constructor. |
|
100 * @param aApp Application creating this document. |
|
101 */ |
|
102 CNPRDocument(CEikApplication& aApp); |
|
103 }; |
|
104 |
|
105 #endif // __NPR_DOCUMENT_H__ |
|
106 // End of File |