epoc32/include/app/vprop.inl
author William Roberts <williamr@symbian.org>
Wed, 31 Mar 2010 12:27:01 +0100
branchSymbian2
changeset 3 e1b950c65cb4
parent 2 epoc32/include/vprop.inl@2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Attempt to represent the S^2->S^3 header reorganisation as a series of "hg rename" operations
williamr@2
     1
// Copyright (c) 1997-2009 Nokia Corporation and/or its subsidiary(-ies).
williamr@2
     2
// All rights reserved.
williamr@2
     3
// This component and the accompanying materials are made available
williamr@2
     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
williamr@2
     5
// which accompanies this distribution, and is available
williamr@2
     6
// at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     7
//
williamr@2
     8
// Initial Contributors:
williamr@2
     9
// Nokia Corporation - initial contribution.
williamr@2
    10
//
williamr@2
    11
// Contributors:
williamr@2
    12
//
williamr@2
    13
// Description:
williamr@2
    14
// CParserPropertyValue
williamr@2
    15
// 
williamr@2
    16
//
williamr@2
    17
williamr@2
    18
inline TUid CParserPropertyValue::Uid() const
williamr@2
    19
/** Returns the property value's UID.
williamr@2
    20
williamr@2
    21
This UID identifies the property value's type and is specified on construction. 
williamr@2
    22
The values are defined in vuid.h.
williamr@2
    23
williamr@2
    24
@return The property value's UID. */
williamr@2
    25
	{return iPropertyValueTypeUid;}
williamr@2
    26
williamr@2
    27
inline void CParserPropertyValue::SetPlugIn(MVersitPlugIn* aPlugIn)
williamr@2
    28
/** Assigns a Versit plug-in to the property value.
williamr@2
    29
williamr@2
    30
Allows functions of the MVersitPlugIn class to be used when writing to a stream.
williamr@2
    31
williamr@2
    32
If a plug-in is in use then this function needs to be called with each property value 
williamr@2
    33
before it is externalised. However, this will be done for you if you add a property 
williamr@2
    34
using the function CVersitParser::AddPropertyL(). 
williamr@2
    35
williamr@2
    36
@param aPlugIn A pointer to an MVersitPlugIn instance. */
williamr@2
    37
	{iPlugIn=aPlugIn;}
williamr@2
    38
williamr@2
    39
inline MVersitPlugIn* CParserPropertyValue::PlugIn()
williamr@2
    40
/** Gets a pointer to the Versit plug-in
williamr@2
    41
williamr@2
    42
@return A pointer to the plug-in. */
williamr@2
    43
	{return iPlugIn;}
williamr@2
    44
williamr@2
    45
//
williamr@2
    46
//  CParserPropertyValueCDesCArray
williamr@2
    47
//
williamr@2
    48
inline CParserPropertyValueBinary::CParserPropertyValueBinary() :CParserPropertyValue(TUid::Uid(KVersitPropertyBinaryUid))
williamr@2
    49
/** Constructs a binary property value. 
williamr@2
    50
williamr@2
    51
Sets the property value UID to KVersitPropertyBinaryUid. */
williamr@2
    52
	{}
williamr@2
    53
williamr@2
    54
inline CParserPropertyValueBinary::CParserPropertyValueBinary(CBufSeg& aValue) :CParserPropertyValue(TUid::Uid(KVersitPropertyBinaryUid)), iValue(&aValue)
williamr@2
    55
/** Constructs a binary property value. 
williamr@2
    56
williamr@2
    57
Sets the property value to aValue and the property value UID to KVersitPropertyBinaryUid.
williamr@2
    58
williamr@2
    59
@param aValue The property value. */
williamr@2
    60
	{}
williamr@2
    61
williamr@2
    62
//
williamr@2
    63
//  CParserPropertyValueCDesCArray
williamr@2
    64
//
williamr@2
    65
inline CDesCArray* CParserPropertyValueCDesCArray::Value() const
williamr@2
    66
/** Gets the property value.
williamr@2
    67
williamr@2
    68
@return Pointer to the array of descriptors owned by the property value object. */
williamr@2
    69
	{return iValue;}
williamr@2
    70
williamr@2
    71
//
williamr@2
    72
// CParserPropertyValueTimeZone
williamr@2
    73
//
williamr@2
    74
inline TTimeIntervalSeconds CParserPropertyValueTimeZone::Value() const
williamr@2
    75
/** Gets the time zone property value.
williamr@2
    76
williamr@2
    77
@return A time interval (in seconds) which represents the offset from universal 
williamr@2
    78
time. */
williamr@2
    79
	{return iValue;}
williamr@2
    80
williamr@2
    81
//
williamr@2
    82
// CParserPropertyValueDaylight
williamr@2
    83
//
williamr@2
    84
inline CVersitDaylight* CParserPropertyValueDaylight::Value() const
williamr@2
    85
/** Gets the daylight saving property value.
williamr@2
    86
williamr@2
    87
@return Pointer to the daylight saving specification. */
williamr@2
    88
	{return iValue;}
williamr@2
    89
williamr@2
    90
//
williamr@2
    91
//  CParserPropertyValueDateTime
williamr@2
    92
//
williamr@2
    93
inline TVersitDateTime* CParserPropertyValueDateTime::Value() const
williamr@2
    94
/** Gets a pointer to the date/time property value.
williamr@2
    95
williamr@2
    96
@return Pointer to the date/time property value. */
williamr@2
    97
	{return iValue;}
williamr@2
    98
williamr@2
    99
//
williamr@2
   100
//  CParserPropertyValueDate
williamr@2
   101
//
williamr@2
   102
inline TVersitDateTime* CParserPropertyValueDate::Value() const
williamr@2
   103
/** Gets a pointer to the date property value.
williamr@2
   104
williamr@2
   105
@return Pointer to the date property value. */
williamr@2
   106
	{return iValue;}
williamr@2
   107
williamr@2
   108
//
williamr@2
   109
//  CParserPropertyValueMultiDateTime
williamr@2
   110
//
williamr@2
   111
inline CArrayPtr<TVersitDateTime>* CParserPropertyValueMultiDateTime::Value() const
williamr@2
   112
/** Gets a pointer to the object's list of date/time property values.
williamr@2
   113
williamr@2
   114
@return Pointer to the array of date/time property values. */
williamr@2
   115
	{return iValue;}
williamr@2
   116
williamr@2
   117
//
williamr@2
   118
//  CParserPropertyValueInt
williamr@2
   119
//
williamr@2
   120
inline TInt CParserPropertyValueInt::Value() const
williamr@2
   121
/** Gets the signed integer property value.
williamr@2
   122
williamr@2
   123
@return The signed integer property value. */
williamr@2
   124
	{return iValue;}
williamr@2
   125
williamr@2
   126
//
williamr@2
   127
//	CParserProperty
williamr@2
   128
//
williamr@2
   129
inline void CParserProperty::SetValue(CParserPropertyValue* aPropertyValue)
williamr@2
   130
/** Sets the property value.
williamr@2
   131
williamr@2
   132
The property takes ownership of the property value.
williamr@2
   133
williamr@2
   134
@param aPropertyValue A pointer to the property value to be set. */
williamr@2
   135
	{iPropertyValue=aPropertyValue;}
williamr@2
   136
williamr@2
   137
inline CParserPropertyValue* CParserProperty::Value() const
williamr@2
   138
/** Gets a pointer to the property value.
williamr@2
   139
williamr@2
   140
Ownership of the property value is not transferred by this function.
williamr@2
   141
williamr@2
   142
@return Pointer to generic parser property value. */
williamr@2
   143
	{return iPropertyValue;}
williamr@2
   144
williamr@2
   145
inline TUid CParserProperty::Uid() const
williamr@2
   146
/** Gets the UID of the property value.
williamr@2
   147
williamr@2
   148
@return UID of the property value. */
williamr@2
   149
	{return iPropertyValue->Uid();}
williamr@2
   150
williamr@2
   151
/*
williamr@2
   152
 * Gets the name of the property.
williamr@2
   153
 *
williamr@2
   154
 * @return    " HBufC8*& "
williamr@2
   155
 *            Pointer to the property name.
williamr@2
   156
 */
williamr@2
   157
inline HBufC8*& CParserProperty::NameBuf()
williamr@2
   158
	{return iPropertyName;}
williamr@2
   159
williamr@2
   160
inline void CParserProperty::SetNameUid(TUid aUid)
williamr@2
   161
/** Sets a property name UID.
williamr@2
   162
williamr@2
   163
This function is called by CVersitParser::AddProperty() when internalising, 
williamr@2
   164
and will not normally be used directly.
williamr@2
   165
williamr@2
   166
@param aUid A property name UID. */
williamr@2
   167
	{iPropertyNameUid=aUid;}
williamr@2
   168
williamr@2
   169
inline TUid CParserProperty::NameUid() const
williamr@2
   170
/** Gets the property name UID.
williamr@2
   171
williamr@2
   172
@return UID of the property name. */
williamr@2
   173
	{return iPropertyNameUid;}
williamr@2
   174
williamr@2
   175
inline void CParserProperty::SetParamArray(CArrayPtr<CParserParam>* aArrayOfParams)
williamr@2
   176
/** Sets the array of property parameters. 
williamr@2
   177
williamr@2
   178
The property takes ownership of aArrayOfParams
williamr@2
   179
williamr@2
   180
@param aArrayOfParams Array of property parameters. */
williamr@2
   181
	{iArrayOfParams=aArrayOfParams;}