|
1 /* |
|
2 * Copyright (c) 2005 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 the License "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: Feeds application's document. |
|
15 * |
|
16 */ |
|
17 |
|
18 #ifndef FEEDS_DOCUMENT_H |
|
19 #define FEEDS_DOCUMENT_H |
|
20 |
|
21 |
|
22 // INCLUDES |
|
23 #include <GenericParamConsumer.h> |
|
24 |
|
25 // CONSTANTS |
|
26 |
|
27 // MACROS |
|
28 |
|
29 // DATA TYPES |
|
30 |
|
31 // FUNCTION PROTOTYPES |
|
32 |
|
33 // FORWARD DECLARATIONS |
|
34 class CFeedsAppUi; |
|
35 class CEikApplication; |
|
36 |
|
37 // CLASS DECLARATION |
|
38 |
|
39 |
|
40 /** |
|
41 * Feeds application's document. |
|
42 * |
|
43 * \b Library: FeedsEngine.lib |
|
44 * |
|
45 * @since 3.0 |
|
46 */ |
|
47 class CFeedsDocument: public CAiwGenericParamConsumer |
|
48 { |
|
49 public: // Constructors and destructor |
|
50 /** |
|
51 * Two-phased constructor. |
|
52 * Construct a CFeedsDocument for the AVKON application aApp. |
|
53 * Using two phase construction, and return a pointer to the created object. |
|
54 * |
|
55 * @since ?? |
|
56 * @param aApp Application creating this document. |
|
57 * @return A pointer to the created instance of CFeedsDocument. |
|
58 */ |
|
59 static CFeedsDocument* NewL(CEikApplication& aApp); |
|
60 |
|
61 /** |
|
62 * Two-phased constructor. |
|
63 * Construct a CFeedsDocument for the AVKON application aApp. |
|
64 * Using two phase construction, and return a pointer to the created object. |
|
65 * |
|
66 * @since ?? |
|
67 * @param aApp Application creating this document. |
|
68 * @return A pointer to the created instance of CFeedsDocument. |
|
69 */ |
|
70 static CFeedsDocument* NewLC(CEikApplication& aApp); |
|
71 |
|
72 /** |
|
73 * Destructor. |
|
74 */ |
|
75 virtual ~CFeedsDocument(); |
|
76 |
|
77 |
|
78 public: // From CAknDocument |
|
79 /** |
|
80 * Creates a CFeedsAppUi object and return a pointer to it. |
|
81 * The object returned is owned by the Uikon framework. |
|
82 * |
|
83 * @since ?? |
|
84 * @return Pointer to created instance of AppUi. |
|
85 */ |
|
86 virtual CEikAppUi* CreateAppUiL(); |
|
87 |
|
88 /** |
|
89 * Opens a given file from the app-framework. |
|
90 * |
|
91 * @since ?? |
|
92 * @param aFileStore ? |
|
93 * @param aFile ? |
|
94 * @return void. |
|
95 */ |
|
96 virtual void OpenFileL(CFileStore*& aFileStore, RFile& aFile); |
|
97 |
|
98 |
|
99 private: |
|
100 /** |
|
101 * C++ default constructor. |
|
102 */ |
|
103 void ConstructL(); |
|
104 |
|
105 /** |
|
106 * By default Symbian 2nd phase constructor is private. |
|
107 */ |
|
108 CFeedsDocument(CEikApplication& aApp); |
|
109 |
|
110 #if 0 |
|
111 /** |
|
112 * Subscribes to a feed, provided via OpenFileL (from an external app). |
|
113 * |
|
114 * @since 3.0 |
|
115 * @param aUrl The feed's url. |
|
116 * @param aContentType The feed's content-type. |
|
117 * @param aCharSet The feed's char-set. |
|
118 * @param aFeedBuffer A buffer containing the downloaded feed. |
|
119 * @return void. |
|
120 */ |
|
121 void SubscribeToL(const TDesC& aUrl, const TDesC& aContentType, |
|
122 const TDesC& aCharSet, HBufC8& aFeedBuffer); |
|
123 |
|
124 /** |
|
125 * Subscribes to a feed. |
|
126 * |
|
127 * @since 3.0 |
|
128 * @param aUrl The feed's name. |
|
129 * @param aUrl The feed's url. |
|
130 * @return void. |
|
131 */ |
|
132 void SubscribeToL(const TDesC& aName, const TDesC& aUrl); |
|
133 #endif |
|
134 }; |
|
135 |
|
136 #endif // FEEDS_DOCUMENT_H |
|
137 |
|
138 // End of File |