1.1 --- /dev/null Thu Jan 01 00:00:00 1970 +0000
1.2 +++ b/epoc32/include/app/vprop.inl Wed Mar 31 12:27:01 2010 +0100
1.3 @@ -0,0 +1,181 @@
1.4 +// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
1.5 +// All rights reserved.
1.6 +// This component and the accompanying materials are made available
1.7 +// 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
1.8 +// which accompanies this distribution, and is available
1.9 +// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
1.10 +//
1.11 +// Initial Contributors:
1.12 +// Nokia Corporation - initial contribution.
1.13 +//
1.14 +// Contributors:
1.15 +//
1.16 +// Description:
1.17 +// CParserPropertyValue
1.18 +//
1.19 +//
1.20 +
1.21 +inline TUid CParserPropertyValue::Uid() const
1.22 +/** Returns the property value's UID.
1.23 +
1.24 +This UID identifies the property value's type and is specified on construction.
1.25 +The values are defined in vuid.h.
1.26 +
1.27 +@return The property value's UID. */
1.28 + {return iPropertyValueTypeUid;}
1.29 +
1.30 +inline void CParserPropertyValue::SetPlugIn(MVersitPlugIn* aPlugIn)
1.31 +/** Assigns a Versit plug-in to the property value.
1.32 +
1.33 +Allows functions of the MVersitPlugIn class to be used when writing to a stream.
1.34 +
1.35 +If a plug-in is in use then this function needs to be called with each property value
1.36 +before it is externalised. However, this will be done for you if you add a property
1.37 +using the function CVersitParser::AddPropertyL().
1.38 +
1.39 +@param aPlugIn A pointer to an MVersitPlugIn instance. */
1.40 + {iPlugIn=aPlugIn;}
1.41 +
1.42 +inline MVersitPlugIn* CParserPropertyValue::PlugIn()
1.43 +/** Gets a pointer to the Versit plug-in
1.44 +
1.45 +@return A pointer to the plug-in. */
1.46 + {return iPlugIn;}
1.47 +
1.48 +//
1.49 +// CParserPropertyValueCDesCArray
1.50 +//
1.51 +inline CParserPropertyValueBinary::CParserPropertyValueBinary() :CParserPropertyValue(TUid::Uid(KVersitPropertyBinaryUid))
1.52 +/** Constructs a binary property value.
1.53 +
1.54 +Sets the property value UID to KVersitPropertyBinaryUid. */
1.55 + {}
1.56 +
1.57 +inline CParserPropertyValueBinary::CParserPropertyValueBinary(CBufSeg& aValue) :CParserPropertyValue(TUid::Uid(KVersitPropertyBinaryUid)), iValue(&aValue)
1.58 +/** Constructs a binary property value.
1.59 +
1.60 +Sets the property value to aValue and the property value UID to KVersitPropertyBinaryUid.
1.61 +
1.62 +@param aValue The property value. */
1.63 + {}
1.64 +
1.65 +//
1.66 +// CParserPropertyValueCDesCArray
1.67 +//
1.68 +inline CDesCArray* CParserPropertyValueCDesCArray::Value() const
1.69 +/** Gets the property value.
1.70 +
1.71 +@return Pointer to the array of descriptors owned by the property value object. */
1.72 + {return iValue;}
1.73 +
1.74 +//
1.75 +// CParserPropertyValueTimeZone
1.76 +//
1.77 +inline TTimeIntervalSeconds CParserPropertyValueTimeZone::Value() const
1.78 +/** Gets the time zone property value.
1.79 +
1.80 +@return A time interval (in seconds) which represents the offset from universal
1.81 +time. */
1.82 + {return iValue;}
1.83 +
1.84 +//
1.85 +// CParserPropertyValueDaylight
1.86 +//
1.87 +inline CVersitDaylight* CParserPropertyValueDaylight::Value() const
1.88 +/** Gets the daylight saving property value.
1.89 +
1.90 +@return Pointer to the daylight saving specification. */
1.91 + {return iValue;}
1.92 +
1.93 +//
1.94 +// CParserPropertyValueDateTime
1.95 +//
1.96 +inline TVersitDateTime* CParserPropertyValueDateTime::Value() const
1.97 +/** Gets a pointer to the date/time property value.
1.98 +
1.99 +@return Pointer to the date/time property value. */
1.100 + {return iValue;}
1.101 +
1.102 +//
1.103 +// CParserPropertyValueDate
1.104 +//
1.105 +inline TVersitDateTime* CParserPropertyValueDate::Value() const
1.106 +/** Gets a pointer to the date property value.
1.107 +
1.108 +@return Pointer to the date property value. */
1.109 + {return iValue;}
1.110 +
1.111 +//
1.112 +// CParserPropertyValueMultiDateTime
1.113 +//
1.114 +inline CArrayPtr<TVersitDateTime>* CParserPropertyValueMultiDateTime::Value() const
1.115 +/** Gets a pointer to the object's list of date/time property values.
1.116 +
1.117 +@return Pointer to the array of date/time property values. */
1.118 + {return iValue;}
1.119 +
1.120 +//
1.121 +// CParserPropertyValueInt
1.122 +//
1.123 +inline TInt CParserPropertyValueInt::Value() const
1.124 +/** Gets the signed integer property value.
1.125 +
1.126 +@return The signed integer property value. */
1.127 + {return iValue;}
1.128 +
1.129 +//
1.130 +// CParserProperty
1.131 +//
1.132 +inline void CParserProperty::SetValue(CParserPropertyValue* aPropertyValue)
1.133 +/** Sets the property value.
1.134 +
1.135 +The property takes ownership of the property value.
1.136 +
1.137 +@param aPropertyValue A pointer to the property value to be set. */
1.138 + {iPropertyValue=aPropertyValue;}
1.139 +
1.140 +inline CParserPropertyValue* CParserProperty::Value() const
1.141 +/** Gets a pointer to the property value.
1.142 +
1.143 +Ownership of the property value is not transferred by this function.
1.144 +
1.145 +@return Pointer to generic parser property value. */
1.146 + {return iPropertyValue;}
1.147 +
1.148 +inline TUid CParserProperty::Uid() const
1.149 +/** Gets the UID of the property value.
1.150 +
1.151 +@return UID of the property value. */
1.152 + {return iPropertyValue->Uid();}
1.153 +
1.154 +/*
1.155 + * Gets the name of the property.
1.156 + *
1.157 + * @return " HBufC8*& "
1.158 + * Pointer to the property name.
1.159 + */
1.160 +inline HBufC8*& CParserProperty::NameBuf()
1.161 + {return iPropertyName;}
1.162 +
1.163 +inline void CParserProperty::SetNameUid(TUid aUid)
1.164 +/** Sets a property name UID.
1.165 +
1.166 +This function is called by CVersitParser::AddProperty() when internalising,
1.167 +and will not normally be used directly.
1.168 +
1.169 +@param aUid A property name UID. */
1.170 + {iPropertyNameUid=aUid;}
1.171 +
1.172 +inline TUid CParserProperty::NameUid() const
1.173 +/** Gets the property name UID.
1.174 +
1.175 +@return UID of the property name. */
1.176 + {return iPropertyNameUid;}
1.177 +
1.178 +inline void CParserProperty::SetParamArray(CArrayPtr<CParserParam>* aArrayOfParams)
1.179 +/** Sets the array of property parameters.
1.180 +
1.181 +The property takes ownership of aArrayOfParams
1.182 +
1.183 +@param aArrayOfParams Array of property parameters. */
1.184 + {iArrayOfParams=aArrayOfParams;}