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