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 "Eclipse Public License v1.0"
5 // which accompanies this distribution, and is available
6 // at the URL "http://www.eclipse.org/legal/epl-v10.html".
8 // Initial Contributors:
9 // Nokia Corporation - initial contribution.
16 inline TUid CParserPropertyValue::Uid() const
17 /** Returns the property value's UID.
19 This UID identifies the property value's type and is specified on construction.
20 The values are defined in vuid.h.
22 @return The property value's UID. */
23 {return iPropertyValueTypeUid;}
25 inline void CParserPropertyValue::SetPlugIn(MVersitPlugIn* aPlugIn)
26 /** Assigns a Versit plug-in to the property value.
28 Allows functions of the MVersitPlugIn class to be used when writing to a stream.
30 If a plug-in is in use then this function needs to be called with each property value
31 before it is externalised. However, this will be done for you if you add a property
32 using the function CVersitParser::AddPropertyL().
34 @param aPlugIn A pointer to an MVersitPlugIn instance. */
37 inline MVersitPlugIn* CParserPropertyValue::PlugIn()
38 /** Gets a pointer to the Versit plug-in
40 @return A pointer to the plug-in. */
44 // CParserPropertyValueCDesCArray
46 inline CParserPropertyValueBinary::CParserPropertyValueBinary() :CParserPropertyValue(TUid::Uid(KVersitPropertyBinaryUid))
47 /** Constructs a binary property value.
49 Sets the property value UID to KVersitPropertyBinaryUid. */
52 inline CParserPropertyValueBinary::CParserPropertyValueBinary(CBufSeg& aValue) :CParserPropertyValue(TUid::Uid(KVersitPropertyBinaryUid)), iValue(&aValue)
53 /** Constructs a binary property value.
55 Sets the property value to aValue and the property value UID to KVersitPropertyBinaryUid.
57 @param aValue The property value. */
61 // CParserPropertyValueCDesCArray
63 inline CDesCArray* CParserPropertyValueCDesCArray::Value() const
64 /** Gets the property value.
66 @return Pointer to the array of descriptors owned by the property value object. */
70 // CParserPropertyValueTimeZone
72 inline TTimeIntervalSeconds CParserPropertyValueTimeZone::Value() const
73 /** Gets the time zone property value.
75 @return A time interval (in seconds) which represents the offset from universal
80 // CParserPropertyValueDaylight
82 inline CVersitDaylight* CParserPropertyValueDaylight::Value() const
83 /** Gets the daylight saving property value.
85 @return Pointer to the daylight saving specification. */
89 // CParserPropertyValueDateTime
91 inline TVersitDateTime* CParserPropertyValueDateTime::Value() const
92 /** Gets a pointer to the date/time property value.
94 @return Pointer to the date/time property value. */
98 // CParserPropertyValueDate
100 inline TVersitDateTime* CParserPropertyValueDate::Value() const
101 /** Gets a pointer to the date property value.
103 @return Pointer to the date property value. */
107 // CParserPropertyValueMultiDateTime
109 inline CArrayPtr<TVersitDateTime>* CParserPropertyValueMultiDateTime::Value() const
110 /** Gets a pointer to the object's list of date/time property values.
112 @return Pointer to the array of date/time property values. */
116 // CParserPropertyValueInt
118 inline TInt CParserPropertyValueInt::Value() const
119 /** Gets the signed integer property value.
121 @return The signed integer property value. */
127 inline void CParserProperty::SetValue(CParserPropertyValue* aPropertyValue)
128 /** Sets the property value.
130 The property takes ownership of the property value.
132 @param aPropertyValue A pointer to the property value to be set. */
133 {iPropertyValue=aPropertyValue;}
135 inline CParserPropertyValue* CParserProperty::Value() const
136 /** Gets a pointer to the property value.
138 Ownership of the property value is not transferred by this function.
140 @return Pointer to generic parser property value. */
141 {return iPropertyValue;}
143 inline TUid CParserProperty::Uid() const
144 /** Gets the UID of the property value.
146 @return UID of the property value. */
147 {return iPropertyValue->Uid();}
150 * Gets the name of the property.
152 * @return " HBufC8*& "
153 * Pointer to the property name.
155 inline HBufC8*& CParserProperty::NameBuf()
156 {return iPropertyName;}
158 inline void CParserProperty::SetNameUid(TUid aUid)
159 /** Sets a property name UID.
161 This function is called by CVersitParser::AddProperty() when internalising,
162 and will not normally be used directly.
164 @param aUid A property name UID. */
165 {iPropertyNameUid=aUid;}
167 inline TUid CParserProperty::NameUid() const
168 /** Gets the property name UID.
170 @return UID of the property name. */
171 {return iPropertyNameUid;}
173 inline void CParserProperty::SetParamArray(CArrayPtr<CParserParam>* aArrayOfParams)
174 /** Sets the array of property parameters.
176 The property takes ownership of aArrayOfParams
178 @param aArrayOfParams Array of property parameters. */
179 {iArrayOfParams=aArrayOfParams;}