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