CSenNamespace Class Reference

API published in: S60 3rd Ed

Link against: senxml.lib

Capability Information

Required Capabilities

None

#include <sennamespace.h>

Detailed Description

Implementation of XML namespace functionality All data is in UTF-8 form.


Public Member Functions
virtual IMPORT_C	~CSenNamespace ()
	Destructor.
IMPORT_C const TDesC8 &	URI () const
	Getter for the URI of the namespace object.
IMPORT_C const TDesC8 &	Prefix () const
	Getter for the prefix of the namespace object.
IMPORT_C void	SetUriL (const TDesC8 &aUri)
	Setter for the URI of the namespace object.
IMPORT_C void	SetPrefixL (const TDesC8 &aPrefix)
	Setter for the prefix of the namespace object.
IMPORT_C TBool	Compare (const TDesC8 &aOtherPrefix, const TDesC8 &aOtherUri) const
	Method for comparing the namespace object to other prefix and URI.
IMPORT_C TBool	Compare (const CSenNamespace &aOtherNamespace) const
	Method for comparing the namespace object to other namespace object.
IMPORT_C TBool	MatchesL (const CSenNamespace &aOtherNamespace) const
	Method for comparing the namespace object to other namespace object.
IMPORT_C void	InsertL (RBufWriteStream &aWs)
	Method to ask this namespace object to write itself into a writestream.
Static Public Member Functions
static IMPORT_C CSenNamespace *	NewL (const TDesC8 &aPrefix, const TDesC8 &aUri)
	Basic constructor.
static IMPORT_C CSenNamespace *	NewLC (const TDesC8 &aPrefix, const TDesC8 &aUri)
	Basic constructor.
static IMPORT_C CSenNamespace *	NewL (const TDesC8 &aUri)
	Basic constructor.
static IMPORT_C CSenNamespace *	NewLC (const TDesC8 &aUri)
	Basic constructor.

Constructor & Destructor Documentation

virtual IMPORT_C CSenNamespace::~CSenNamespace ( ) [virtual]

Destructor.

Member Function Documentation

IMPORT_C TBool CSenNamespace::Compare

const CSenNamespace &

aOtherNamespace

Method for comparing the namespace object to other namespace object.

Parameters:

aOtherNamespace

The namespace to be compared to.

Returns:: ETrue if the given namespace has same URI and prefix as the current one. EFalse otherwise.

IMPORT_C TBool CSenNamespace::Compare	(	const TDesC8 &	aOtherPrefix,
		const TDesC8 &	aOtherUri
	)	const

Method for comparing the namespace object to other prefix and URI.

Parameters:

	aOtherPrefix	The prefix to be compared to
	aOtherUri	The URI to be compared to.

Returns:: ETrue if both of the parameters were matching to the object's corresponding ones. EFalse otherwise

IMPORT_C void CSenNamespace::InsertL

RBufWriteStream &

Method to ask this namespace object to write itself into a writestream.

Doesn't write anything if no URI has been set.

Parameters:

The writestream where object should be written.

IMPORT_C TBool CSenNamespace::MatchesL

const CSenNamespace &

aOtherNamespace

Method for comparing the namespace object to other namespace object.

Differs from Compare(...) methods so that this one compares only URIs.

Returns:: ETrue if the given namespace has the same URI as the current one. EFalse otherwise.

static IMPORT_C CSenNamespace* CSenNamespace::NewL ( const TDesC8 & aUri ) [static]

Basic constructor.

Parameters:

The namespace uri for the namespace.

static IMPORT_C CSenNamespace* CSenNamespace::NewL	(	const TDesC8 &	aPrefix,
		const TDesC8 &	aUri
	)	`[static]`

Basic constructor.

Parameters:

	aPrefix	The prefix for the namespace.
	aUri	The namespace uri for the namespace.

static IMPORT_C CSenNamespace* CSenNamespace::NewLC ( const TDesC8 & aUri ) [static]

Basic constructor.

Parameters:

The namespace uri for the namespace.

static IMPORT_C CSenNamespace* CSenNamespace::NewLC	(	const TDesC8 &	aPrefix,
		const TDesC8 &	aUri
	)	`[static]`

Basic constructor.

Parameters:

	aPrefix	The prefix for the namespace.
	aUri	The namespace uri for the namespace.

IMPORT_C const TDesC8& CSenNamespace::Prefix

Getter for the prefix of the namespace object.

Returns:: The prefix

IMPORT_C void CSenNamespace::SetPrefixL

Setter for the prefix of the namespace object.

Parameters:

IMPORT_C void CSenNamespace::SetUriL

Setter for the URI of the namespace object.

Parameters:

IMPORT_C const TDesC8& CSenNamespace::URI

Getter for the URI of the namespace object.

Returns:: The URI

The documentation for this class was generated from the following file:

sennamespace.h

Copyright © Nokia Corporation 2001-2008