epoc32/include/SyncMLTransportProperties.h
author William Roberts <williamr@symbian.org>
Tue, 16 Mar 2010 16:12:26 +0000
branchSymbian2
changeset 2 2fe1408b6811
child 4 837f303aceeb
permissions -rw-r--r--
Final list of Symbian^2 public API header files
williamr@2
     1
/*
williamr@2
     2
* Copyright (c) 2009 Nokia Corporation and/or its subsidiary(-ies). 
williamr@2
     3
* All rights reserved.
williamr@2
     4
* This component and the accompanying materials are made available
williamr@2
     5
* 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
     6
* which accompanies this distribution, and is available
williamr@2
     7
* at the URL "http://www.symbianfoundation.org/legal/licencesv10.html".
williamr@2
     8
*
williamr@2
     9
* Initial Contributors:
williamr@2
    10
* Nokia Corporation - initial contribution.
williamr@2
    11
*
williamr@2
    12
* Contributors:
williamr@2
    13
*
williamr@2
    14
* Description: SyncML Transport properties.
williamr@2
    15
*
williamr@2
    16
*/
williamr@2
    17
///////////////////////////////////////////////////////////////////////////////
williamr@2
    18
// SyncMLTransportProperties.h
williamr@2
    19
//
williamr@2
    20
//
williamr@2
    21
///////////////////////////////////////////////////////////////////////////////
williamr@2
    22
#ifndef __SYNCMLTRANSPORTPROPERTIES_H__
williamr@2
    23
#define __SYNCMLTRANSPORTPROPERTIES_H__
williamr@2
    24
//
williamr@2
    25
#include <e32base.h>
williamr@2
    26
#include <syncmldef.h>
williamr@2
    27
class RReadStream;
williamr@2
    28
class RWriteStream;
williamr@2
    29
//
williamr@2
    30
williamr@2
    31
/**
williamr@2
    32
	Data type of a SyncML transport property value.
williamr@2
    33
*/
williamr@2
    34
enum TSyncMLTransportPropertyDataType
williamr@2
    35
	{
williamr@2
    36
	/** Narrow text. */
williamr@2
    37
	EDataTypeText8,
williamr@2
    38
	/** Number. */
williamr@2
    39
	EDataTypeNumber,
williamr@2
    40
	/** Boolean. */
williamr@2
    41
	EDataTypeBoolean
williamr@2
    42
	};
williamr@2
    43
williamr@2
    44
class TSyncMLTransportPropertyInfo
williamr@2
    45
/**	Information about a SyncML transport property.
williamr@2
    46
	@see CSmlTransportPropertiesArray
williamr@2
    47
	@publishedAll
williamr@2
    48
	@released
williamr@2
    49
*/
williamr@2
    50
	{
williamr@2
    51
public:
williamr@2
    52
	IMPORT_C void InternalizeL(RReadStream& aStream);
williamr@2
    53
	IMPORT_C void ExternalizeL(RWriteStream& aStream) const;
williamr@2
    54
public:
williamr@2
    55
	/** Property data type. */
williamr@2
    56
	TSyncMLTransportPropertyDataType iDataType;
williamr@2
    57
	/** Property name. */
williamr@2
    58
	TBuf8<KSmlMaxTransportPropertyNameLen> iName;
williamr@2
    59
	};
williamr@2
    60
williamr@2
    61
williamr@2
    62
class CSyncMLTransportPropertiesArray : public CBase
williamr@2
    63
/**	An array of SyncML transport property information.
williamr@2
    64
	
williamr@2
    65
	This is used to store information about the properties supported by a transport type.
williamr@2
    66
	@publishedAll
williamr@2
    67
	@released
williamr@2
    68
	@see RSyncMLTransport::Properties() 
williamr@2
    69
*/
williamr@2
    70
	{
williamr@2
    71
public:
williamr@2
    72
	/** Information about a property. */
williamr@2
    73
	typedef TSyncMLTransportPropertyInfo TPropertyInfo;
williamr@2
    74
public:
williamr@2
    75
	IMPORT_C CSyncMLTransportPropertiesArray(TInt aGranularity);
williamr@2
    76
	IMPORT_C void InternalizeL(RReadStream&);
williamr@2
    77
	IMPORT_C void ExternalizeL(RWriteStream&) const;
williamr@2
    78
	IMPORT_C TInt AddL(const TPropertyInfo&);
williamr@2
    79
	IMPORT_C void Delete(TInt aIndex);
williamr@2
    80
	IMPORT_C TInt Find(const TDesC8& aPropertyName) const;
williamr@2
    81
	IMPORT_C TInt Count() const;
williamr@2
    82
	IMPORT_C TPropertyInfo& At(TInt aIndex);
williamr@2
    83
	IMPORT_C const TPropertyInfo& At(TInt aIndex) const;
williamr@2
    84
	inline TPropertyInfo& operator[](TInt aIndex);
williamr@2
    85
	inline const TPropertyInfo& operator[](TInt aIndex) const;
williamr@2
    86
private:
williamr@2
    87
	CArrayFixFlat<TPropertyInfo> iElements;
williamr@2
    88
	};
williamr@2
    89
williamr@2
    90
inline TSyncMLTransportPropertyInfo& CSyncMLTransportPropertiesArray::operator[](TInt aIndex)
williamr@2
    91
/**
williamr@2
    92
Gets the member of the array with the specified index value.
williamr@2
    93
@return	Property value at array index aIndex		
williamr@2
    94
@param aIndex Index value
williamr@2
    95
*/
williamr@2
    96
	{ return At(aIndex); }
williamr@2
    97
williamr@2
    98
inline const TSyncMLTransportPropertyInfo& CSyncMLTransportPropertiesArray::operator[](TInt aIndex) const
williamr@2
    99
/**
williamr@2
   100
Gets the member of the array with the specified index value (const overload).
williamr@2
   101
@return	Property value at array index aIndex		
williamr@2
   102
@param aIndex Index value
williamr@2
   103
*/
williamr@2
   104
	{ return At(aIndex); }
williamr@2
   105
williamr@2
   106
williamr@2
   107
///////////////////////////////////////////////////////////////////////////////
williamr@2
   108
///////////////////////////////////////////////////////////////////////////////
williamr@2
   109
///////////////////////////////////////////////////////////////////////////////
williamr@2
   110
#endif // __SYNCMLTRANSPORTPROPERTIES_H__