1 /** @file |
|
2 * Copyright (c) 2005-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 "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: Describe a path element |
|
15 * |
|
16 */ |
|
17 |
|
18 |
|
19 #ifndef C_CUPNPPATHELEMENT_H |
|
20 #define C_CUPNPPATHELEMENT_H |
|
21 |
|
22 // INCLUDES |
|
23 #include <e32base.h> |
|
24 |
|
25 // CLASS DECLARATION |
|
26 /** |
|
27 * Describe a path element |
|
28 * |
|
29 * @since Series 60 3.1 |
|
30 */ |
|
31 class CUpnpPathElement: public CBase |
|
32 { |
|
33 public: // Constructors and destructor |
|
34 /** |
|
35 * Two-phased constructor. |
|
36 */ |
|
37 static CUpnpPathElement* NewL(); |
|
38 /** |
|
39 * Destructor. |
|
40 */ |
|
41 virtual ~CUpnpPathElement(); |
|
42 |
|
43 public: // New functions |
|
44 /** |
|
45 * Get value of parent id |
|
46 * @since Series 60 3.1 |
|
47 * @return parent id |
|
48 */ |
|
49 const TDesC8& ParentId() const; |
|
50 /** |
|
51 * Set value of parent id |
|
52 * @since Series 60 3.1 |
|
53 * @param aParentId new value of parent id |
|
54 */ |
|
55 void SetParentIdL(const TDesC8& aParentId); |
|
56 /** |
|
57 * Get value of id |
|
58 * @since Series 60 3.1 |
|
59 * @return id value |
|
60 */ |
|
61 const TDesC8& Id() const; |
|
62 /** |
|
63 * Set value of id |
|
64 * @since Series 60 3.1 |
|
65 * @param aId new value of id |
|
66 */ |
|
67 void SetIdL(const TDesC8& aId); |
|
68 /** |
|
69 * Get value of name |
|
70 * @since Series 60 3.1 |
|
71 * @return name |
|
72 */ |
|
73 const TDesC8& Name() const; |
|
74 /** |
|
75 * Set value of name |
|
76 * @since Series 60 3.1 |
|
77 * @param aName new value of name |
|
78 */ |
|
79 void SetNameL(const TDesC8& aName); |
|
80 |
|
81 /** |
|
82 * Get value of ImportURI |
|
83 * @since Series 60 3.2 |
|
84 * @return ImportURI |
|
85 */ |
|
86 const TDesC8& ImportURI() const; |
|
87 /** |
|
88 * Set value of ImportURI |
|
89 * @since Series 60 3.2 |
|
90 * @param aImportURI a new value of importURI |
|
91 */ |
|
92 void SetImportURIL(const TDesC8& aImportURI); |
|
93 |
|
94 /** |
|
95 * Get value of original name |
|
96 * @since Series 60 3.2 |
|
97 * @return OriginalName |
|
98 */ |
|
99 const TDesC8& OriginalName() const; |
|
100 |
|
101 /** |
|
102 * Set value of original name |
|
103 * @since Series 60 3.2 |
|
104 * @param aIOriginalName a new value of original name |
|
105 */ |
|
106 void SetOriginalNameL(const TDesC8& aOriginalName); |
|
107 |
|
108 /** |
|
109 * Deletes value of original name |
|
110 * @since Series 60 3.2 |
|
111 */ |
|
112 void DeleteOriginalName(); |
|
113 |
|
114 /** |
|
115 Compares if two path elements have the same name and parent id. |
|
116 @param aFirst First message to compare. |
|
117 @param aSecond Second message to compare. |
|
118 @result ETrue if same session id, EFalse otherwise. |
|
119 **/ |
|
120 static TBool MatchName(const CUpnpPathElement& aElement1, |
|
121 const CUpnpPathElement& aElement2); |
|
122 /** |
|
123 Compares if two path elements have the same name, id and parent id. |
|
124 @param aFirst First message to compare. |
|
125 @param aSecond Second message to compare. |
|
126 @result ETrue if same session id, EFalse otherwise. |
|
127 **/ |
|
128 static TBool MatchAll(const CUpnpPathElement& aElement1, |
|
129 const CUpnpPathElement& aElement2); |
|
130 |
|
131 private: |
|
132 /** |
|
133 * C++ default constructor. |
|
134 */ |
|
135 CUpnpPathElement(); |
|
136 |
|
137 /** |
|
138 * Symbian 2nd phase constructor |
|
139 */ |
|
140 void ConstructL(); |
|
141 |
|
142 private: |
|
143 // id attrbute of UPnP object |
|
144 HBufC8* iId; |
|
145 // parent id attrbute of UPnP object |
|
146 HBufC8* iParentId; |
|
147 // name path element, name is taken from title element, |
|
148 // but if duplication occurs, name is followed by index string |
|
149 HBufC8* iName; |
|
150 //hidden import URI |
|
151 HBufC8* iImportURI; |
|
152 //original name if change by creating resource |
|
153 HBufC8* iOriginalName; |
|
154 }; |
|
155 |
|
156 #endif // C_CUPNPPATHELEMENT_H |
|
157 |
|
158 // End of File |
|