|
1 /* |
|
2 * Copyright (c) 2006 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: Defines data class structure for the API* |
|
15 */ |
|
16 |
|
17 |
|
18 |
|
19 |
|
20 #ifndef CIPTVMYVIDEOSGLOBALFOLDERID_H |
|
21 #define CIPTVMYVIDEOSGLOBALFOLDERID_H |
|
22 |
|
23 // INCLUDES |
|
24 #include <e32std.h> |
|
25 #include "CIptvUtil.h" |
|
26 |
|
27 class RWriteStream; |
|
28 class RReadStream; |
|
29 |
|
30 // CLASS DECLARATION |
|
31 |
|
32 /** |
|
33 * Defines data class structure for the API. |
|
34 * |
|
35 * @lib IptvClientApi.dll |
|
36 */ |
|
37 class CIptvMyVideosGlobalFolderId : public CBase |
|
38 { |
|
39 public: |
|
40 |
|
41 /** |
|
42 * Two-phased constructor. |
|
43 * |
|
44 * @return New CIptvMyVideosGlobalFolderId object. |
|
45 */ |
|
46 IMPORT_C static CIptvMyVideosGlobalFolderId* NewL(); |
|
47 |
|
48 /** |
|
49 * Two-phased constructor. |
|
50 * |
|
51 * @return New CIptvMyVideosGlobalFolderId object. |
|
52 */ |
|
53 IMPORT_C static CIptvMyVideosGlobalFolderId* NewLC(); |
|
54 |
|
55 /** |
|
56 * Get object representing any of the root folders. These objects |
|
57 * are needed when copying/moving folders/files to root of some |
|
58 * drive. Method performs also basic functionality of NewL(). |
|
59 * |
|
60 * @param aDrive Requested drive for root folder. Possible enumeration |
|
61 * values are EDriveC and EDriveE. Leave empty or use -1 |
|
62 * to point to root of all drives (when for example just |
|
63 * listing all folders and files). |
|
64 * @return New CIptvMyVideosGlobalFolderId object. |
|
65 */ |
|
66 IMPORT_C static CIptvMyVideosGlobalFolderId* NewRootFolderL(TInt aDrive = -1); |
|
67 |
|
68 /** |
|
69 * Destructor. |
|
70 */ |
|
71 virtual ~CIptvMyVideosGlobalFolderId(); |
|
72 |
|
73 /** |
|
74 * Externalize. |
|
75 * |
|
76 * @param aStream Stream to externalize object to. |
|
77 */ |
|
78 IMPORT_C void ExternalizeL(RWriteStream& aStream) const; |
|
79 |
|
80 /** |
|
81 * Internalize. |
|
82 * |
|
83 * @param aStream Stream to internalize object from. |
|
84 */ |
|
85 IMPORT_C void InternalizeL(RReadStream& aStream); |
|
86 |
|
87 /** |
|
88 * Count externalized size. |
|
89 * |
|
90 * @return Externalized size. |
|
91 */ |
|
92 IMPORT_C TUint32 CountExternalizeSize(); |
|
93 |
|
94 public: // Data. |
|
95 |
|
96 /** |
|
97 * See TDriveNumber, EDriveC and EDriveE allowed. |
|
98 */ |
|
99 TInt iDrive; |
|
100 |
|
101 /** |
|
102 * Drive specific folder ID identifier. |
|
103 */ |
|
104 TIptvFolderId iFolderId; |
|
105 |
|
106 protected: |
|
107 |
|
108 /** |
|
109 * C++ default constructor. |
|
110 */ |
|
111 CIptvMyVideosGlobalFolderId(); |
|
112 |
|
113 /** |
|
114 * Symbian 2nd phase constructor. |
|
115 */ |
|
116 void ConstructL(); |
|
117 }; |
|
118 |
|
119 #endif // CIPTVMYVIDEOSGLOBALFOLDERID_H |
|
120 |
|
121 // End of File |