Collapse all Symbian^3 Product Developer Library

CSenXmlProperties Class Reference

class CSenXmlProperties : public CBase

Inherits from

CSenXmlProperties
- CBase

Public Member Functions
	~CSenXmlProperties()
HBufC8 *	AsUtf8L()
HBufC8 *	AsUtf8LC()
TInt	BoolPropertyL(const TDesC8 &, TBool &)
MSenProperties *	Clone(TInt &)
MSenProperties *	CloneL()
TInt	IntPropertyL(const TDesC8 &, TInt &)
TBool	IsSafeToCast(TSenPropertiesClassType)
IMPORT_C CSenXmlProperties *	NewL()
IMPORT_C CSenXmlProperties *	NewL(const TDesC8 &, CSenXmlReader &)
IMPORT_C CSenXmlProperties *	NewL(const CSenElement &)
IMPORT_C CSenXmlProperties *	NewLC()
IMPORT_C CSenXmlProperties *	NewLC(const TDesC8 &, CSenXmlReader &)
IMPORT_C CSenXmlProperties *	NewLC(const CSenElement &)
TSenPropertiesClassType	PropertiesClassType()
TInt	PropertyL(const TDesC8 &, TPtrC8 &)
TInt	PropertyL(const TDesC8 &, TPtrC8 &, TPtrC8 &)
void	ReadFromL(const TDesC8 &)
TInt	RemovePropertyL(const TDesC8 &)
TInt	SetBoolPropertyL(const TDesC8 &, const TBool)
TInt	SetIntPropertyL(const TDesC8 &, const TInt)
TInt	SetOmittedL(const TDesC8 &, TBool)
TInt	SetPropertyL(const TDesC8 &, const TDesC8 &)
TInt	SetPropertyL(const TDesC8 &, const TDesC8 &, const TDesC8 &)
void	SetReader(CSenXmlReader &)
void	WriteToL(RWriteStream &)

Protected Member Functions
	CSenXmlProperties()
void	BaseConstructL(const TDesC8 &, const TDesC8 &, CSenXmlReader *)
void	BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)
void	BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)
void	BaseConstructL(const CSenElement &)

Inherited Functions
	CBase::CBase()
	CBase::Delete(CBase *)
	CBase::Extension_(TUint,TAny &,TAny )
	CBase::operator new(TUint)
	CBase::operator new(TUint,TAny *)
	CBase::operator new(TUint,TLeave)
	CBase::operator new(TUint,TLeave,TUint)
	CBase::operator new(TUint,TUint)
	CBase::~CBase()

Protected Attributes
CSenPropertiesFragment *	ipFragment
CSenXmlReader *	ipReader

Constructor & Destructor Documentation

CSenXmlProperties()

CSenXmlProperties

(

)

[protected]

Constructor.

~CSenXmlProperties()

~CSenXmlProperties

(

)

[virtual]

Destructor.

Member Functions Documentation

AsUtf8L()

HBufC8 *

AsUtf8L

(

)

[virtual]

AsUtf8LC()

HBufC8 *

AsUtf8LC

(

)

[virtual]

BaseConstructL(const TDesC8 &, const TDesC8 &, CSenXmlReader *)

void	BaseConstructL	(	const TDesC8 &	aLocalname,
			const TDesC8 &	aXml,
			CSenXmlReader *	aParser = NULL
		)	[protected, virtual]

Parameters

const TDesC8 & aLocalname
const TDesC8 & aXml
CSenXmlReader * aParser = NULL

BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)

void	BaseConstructL	(	const TDesC8 &	aNamespace,
			const TDesC8 &	aLocalname,
			const TDesC8 &	aXml,
			CSenXmlReader *	aParser = NULL
		)	[protected, virtual]

Parameters

const TDesC8 & aNamespace
const TDesC8 & aLocalname
const TDesC8 & aXml
CSenXmlReader * aParser = NULL

BaseConstructL(const TDesC8 &, const TDesC8 &, const TDesC8 &, const TDesC8 &, CSenXmlReader *)

void	BaseConstructL	(	const TDesC8 &	aNamespace,
			const TDesC8 &	aLocalname,
			const TDesC8 &	aQualifiedName,
			const TDesC8 &	aXml,
			CSenXmlReader *	aParser = NULL
		)	[protected, virtual]

Parameters

const TDesC8 & aNamespace
const TDesC8 & aLocalname
const TDesC8 & aQualifiedName
const TDesC8 & aXml
CSenXmlReader * aParser = NULL

BaseConstructL(const CSenElement &)

void

BaseConstructL

(

const CSenElement &

aElement

)

[protected, virtual]

Parameters

const CSenElement & aElement

BoolPropertyL(const TDesC8 &, TBool &)

TInt	BoolPropertyL	(	const TDesC8 &	aName,
			TBool &	aValue
		)	[virtual]

Parameters

const TDesC8 & aName
TBool & aValue

Clone(TInt &)

MSenProperties *

Clone

(

TInt &

aOkOrError

)

const [virtual]

Parameters

TInt & aOkOrError

CloneL()

MSenProperties *

CloneL

(

)

const [virtual]

IntPropertyL(const TDesC8 &, TInt &)

TInt	IntPropertyL	(	const TDesC8 &	aName,
			TInt &	aValue
		)	[virtual]

Parameters

const TDesC8 & aName
TInt & aValue

IsSafeToCast(TSenPropertiesClassType)

TBool

IsSafeToCast

(

TSenPropertiesClassType

aClass

)

[virtual]

Parameters

TSenPropertiesClassType aClass

NewL()

IMPORT_C CSenXmlProperties *

NewL

(

)

[static]

Basic constructor.

NewL(const TDesC8 &, CSenXmlReader &)

IMPORT_C CSenXmlProperties *	NewL	(	const TDesC8 &	aXmlUtf8,
			CSenXmlReader &	aParser
		)	[static]

Basic constructor.

Parameters

const TDesC8 & aXmlUtf8
CSenXmlReader & aParser	It is a XML reader

NewL(const CSenElement &)

IMPORT_C CSenXmlProperties *

NewL

(

const CSenElement &

aElement

)

[static]

Basic constructor.

Parameters

const CSenElement & aElement

NewLC()

IMPORT_C CSenXmlProperties *

NewLC

(

)

[static]

Basic constructor.

NewLC(const TDesC8 &, CSenXmlReader &)

IMPORT_C CSenXmlProperties *	NewLC	(	const TDesC8 &	aXmlUtf8,
			CSenXmlReader &	aParser
		)	[static]

Basic constructor.

Parameters

const TDesC8 & aXmlUtf8
CSenXmlReader & aParser	It is a XML reader

NewLC(const CSenElement &)

IMPORT_C CSenXmlProperties *

NewLC

(

const CSenElement &

aElement

)

[static]

Basic constructor.

Parameters

const CSenElement & aElement

PropertiesClassType()

TSenPropertiesClassType

PropertiesClassType

(

)

[virtual]

PropertyL(const TDesC8 &, TPtrC8 &)

TInt	PropertyL	(	const TDesC8 &	aName,
			TPtrC8 &	aValue
		)	[virtual]

Parameters

const TDesC8 & aName
TPtrC8 & aValue

PropertyL(const TDesC8 &, TPtrC8 &, TPtrC8 &)

TInt	PropertyL	(	const TDesC8 &	aName,
			TPtrC8 &	aValue,
			TPtrC8 &	aType
		)	[virtual]

Gets the value of the property behind certain name.

Since: Series60

Parameters

const TDesC8 & aName	The name identifying this property.
TPtrC8 & aValue	A TPtrC8 reference to be filled in with the value of the property.
TPtrC8 & aType	A TPtrC8 reference to be filled in with the type of the property.

ReadFromL(const TDesC8 &)

void

ReadFromL

(

const TDesC8 &

aBuffer

)

[virtual]

Parameters

const TDesC8 & aBuffer

RemovePropertyL(const TDesC8 &)

TInt

RemovePropertyL

(

const TDesC8 &

aName

)

[virtual]

Parameters

const TDesC8 & aName

SetBoolPropertyL(const TDesC8 &, const TBool)

TInt	SetBoolPropertyL	(	const TDesC8 &	aName,
			const TBool	aValue
		)	[virtual]

MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.

Parameters

const TDesC8 & aName
const TBool aValue

SetIntPropertyL(const TDesC8 &, const TInt)

TInt	SetIntPropertyL	(	const TDesC8 &	aName,
			const TInt	aValue
		)	[virtual]

MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.

Parameters

const TDesC8 & aName
const TInt aValue

SetOmittedL(const TDesC8 &, TBool)

TInt	SetOmittedL	(	const TDesC8 &	aName,
			TBool	aValue
		)	[virtual]

Parameters

const TDesC8 & aName
TBool aValue

SetPropertyL(const TDesC8 &, const TDesC8 &)

TInt	SetPropertyL	(	const TDesC8 &	aName,
			const TDesC8 &	aValue
		)	[virtual]

MSenProperties Leave codes: KErrSenInvalidCharacters if aName contains illegal characters. KErrSenZeroLengthDescriptor if aName is zero length.

Parameters

const TDesC8 & aName
const TDesC8 & aValue

SetPropertyL(const TDesC8 &, const TDesC8 &, const TDesC8 &)

TInt	SetPropertyL	(	const TDesC8 &	aName,
			const TDesC8 &	aValue,
			const TDesC8 &	aType
		)	[virtual]

Sets new property.

If property with given name does not exist, new property with given value will be added. Otherwise the value of existing property will be updated.

Since: Series60

Parameters

const TDesC8 & aName	Name of the property, which can be later used to refer the given value.
const TDesC8 & aValue	Is the value of this property.
const TDesC8 & aType	Is the type of this property.