1 // Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
2 // All rights reserved.
3 // This component and the accompanying materials are made available
4 // under the terms of the License "Symbian Foundation License v1.0" to Symbian Foundation members and "Symbian Foundation End User License Agreement v1.0" to non-members
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
14 // CParserPropertyValue
18 inline TUid CParserPropertyValue::Uid() const
19 /** Returns the property value's UID.
21 This UID identifies the property value's type and is specified on construction.
22 The values are defined in vuid.h.
24 @return The property value's UID. */
25 {return iPropertyValueTypeUid;}
27 inline void CParserPropertyValue::SetPlugIn(MVersitPlugIn* aPlugIn)
28 /** Assigns a Versit plug-in to the property value.
30 Allows functions of the MVersitPlugIn class to be used when writing to a stream.
32 If a plug-in is in use then this function needs to be called with each property value
33 before it is externalised. However, this will be done for you if you add a property
34 using the function CVersitParser::AddPropertyL().
36 @param aPlugIn A pointer to an MVersitPlugIn instance. */
39 inline MVersitPlugIn* CParserPropertyValue::PlugIn()
40 /** Gets a pointer to the Versit plug-in
42 @return A pointer to the plug-in. */
46 // CParserPropertyValueCDesCArray
48 inline CParserPropertyValueBinary::CParserPropertyValueBinary() :CParserPropertyValue(TUid::Uid(KVersitPropertyBinaryUid))
49 /** Constructs a binary property value.
51 Sets the property value UID to KVersitPropertyBinaryUid. */
54 inline CParserPropertyValueBinary::CParserPropertyValueBinary(CBufSeg& aValue) :CParserPropertyValue(TUid::Uid(KVersitPropertyBinaryUid)), iValue(&aValue)
55 /** Constructs a binary property value.
57 Sets the property value to aValue and the property value UID to KVersitPropertyBinaryUid.
59 @param aValue The property value. */
63 // CParserPropertyValueCDesCArray
65 inline CDesCArray* CParserPropertyValueCDesCArray::Value() const
66 /** Gets the property value.
68 @return Pointer to the array of descriptors owned by the property value object. */
72 // CParserPropertyValueTimeZone
74 inline TTimeIntervalSeconds CParserPropertyValueTimeZone::Value() const
75 /** Gets the time zone property value.
77 @return A time interval (in seconds) which represents the offset from universal
82 // CParserPropertyValueDaylight
84 inline CVersitDaylight* CParserPropertyValueDaylight::Value() const
85 /** Gets the daylight saving property value.
87 @return Pointer to the daylight saving specification. */
91 // CParserPropertyValueDateTime
93 inline TVersitDateTime* CParserPropertyValueDateTime::Value() const
94 /** Gets a pointer to the date/time property value.
96 @return Pointer to the date/time property value. */
100 // CParserPropertyValueDate
102 inline TVersitDateTime* CParserPropertyValueDate::Value() const
103 /** Gets a pointer to the date property value.
105 @return Pointer to the date property value. */
109 // CParserPropertyValueMultiDateTime
111 inline CArrayPtr<TVersitDateTime>* CParserPropertyValueMultiDateTime::Value() const
112 /** Gets a pointer to the object's list of date/time property values.
114 @return Pointer to the array of date/time property values. */
118 // CParserPropertyValueInt
120 inline TInt CParserPropertyValueInt::Value() const
121 /** Gets the signed integer property value.
123 @return The signed integer property value. */
129 inline void CParserProperty::SetValue(CParserPropertyValue* aPropertyValue)
130 /** Sets the property value.
132 The property takes ownership of the property value.
134 @param aPropertyValue A pointer to the property value to be set. */
135 {iPropertyValue=aPropertyValue;}
137 inline CParserPropertyValue* CParserProperty::Value() const
138 /** Gets a pointer to the property value.
140 Ownership of the property value is not transferred by this function.
142 @return Pointer to generic parser property value. */
143 {return iPropertyValue;}
145 inline TUid CParserProperty::Uid() const
146 /** Gets the UID of the property value.
148 @return UID of the property value. */
149 {return iPropertyValue->Uid();}
152 * Gets the name of the property.
154 * @return " HBufC8*& "
155 * Pointer to the property name.
157 inline HBufC8*& CParserProperty::NameBuf()
158 {return iPropertyName;}
160 inline void CParserProperty::SetNameUid(TUid aUid)
161 /** Sets a property name UID.
163 This function is called by CVersitParser::AddProperty() when internalising,
164 and will not normally be used directly.
166 @param aUid A property name UID. */
167 {iPropertyNameUid=aUid;}
169 inline TUid CParserProperty::NameUid() const
170 /** Gets the property name UID.
172 @return UID of the property name. */
173 {return iPropertyNameUid;}
175 inline void CParserProperty::SetParamArray(CArrayPtr<CParserParam>* aArrayOfParams)
176 /** Sets the array of property parameters.
178 The property takes ownership of aArrayOfParams
180 @param aArrayOfParams Array of property parameters. */
181 {iArrayOfParams=aArrayOfParams;}