Collapse all Symbian^3 Application Developer Library

Xml::MStringDictionary Class Reference

class Xml::MStringDictionary

This interface defines the API of a single string dictionary. This class is not used directly, but via a derived class the user provides. Derived classes must add all elements, attributes names, and attribute values that belong to this string dictionary as static string tables to the StringPool. WBXML token mappings between strings and WBXML tokens should also be maintained. RStringPool

Public Member Functions
void	AttributeL ( TInt , RString &)
void	AttributeValueL ( TInt , RString &)
void	AttributeValuePairL ( TInt , RString &, RString &)
TBool	CompareThisDictionary (const RString &)
void	ElementL ( TInt , RString &)
void	NamespaceUri ( RString &)
void	PublicIdentifier ( RString &)
void	Release ()
TInt	SwitchCodePage ( TInt )

Member Functions Documentation

AttributeL(TInt, RString &)

void	AttributeL	(	TInt	aToken,
			RString &	aAttribute
		)	const [pure virtual]

This method returns the attribute string associated with the given token.

leave: KErrXmlUnsupportedAttribute, if the token doesn't correspond to an attribute.

Parameters

TInt aToken	the attribute token.
RString & aAttribute	On return reflects the string corresponding to the token.

AttributeValueL(TInt, RString &)

void	AttributeValueL	(	TInt	aToken,
			RString &	aValue
		)	const [pure virtual]

This method returns the value string associated with the given token.

leave: KErrXmlUnsupportedAttributeValue, if the token doesn't correspond to value.

Parameters

TInt aToken	the attribute token.
RString & aValue	On return reflects the string corresponding to the value for this attibute.

AttributeValuePairL(TInt, RString &, RString &)

void	AttributeValuePairL	(	TInt	aToken,
			RString &	aAttribute,
			RString &	aValue
		)	const [pure virtual]

This method returns the attribute and value string associated with the given token.

leave: KErrXmlUnsupportedAttribute, if the token doesn't correspond to an attribute

leave: KErrXmlUnsupportedAttributeValue, if the token doesn't correspond to a value

Parameters

TInt aToken	the attribute token.
RString & aAttribute	On return reflects the string corresponding to the token.
RString & aValue	On return reflects the string corresponding to the value for this attibute.

CompareThisDictionary(const RString &)

TBool

CompareThisDictionary

(

const RString &

aDictionaryDescription

)

const [pure virtual]

This method compares the Dictionary description with that provided.

Parameters

const RString & aDictionaryDescription

The description we want to compare.

ElementL(TInt, RString &)

void	ElementL	(	TInt	aToken,
			RString &	aElement
		)	const [pure virtual]

This method returns the element string associated with the given token.

leave: KErrXmlUnsupportedElement, if the token doesn't correspond to an element.

Parameters

TInt aToken	the element token.
RString & aElement	On return reflects the string corresponding to the token.

NamespaceUri(RString &)

void

NamespaceUri

(

RString &

aUri

)

[pure virtual]

The element types in the Device Information DTD are defined within a namespace associated with the Uri/Urn available from the StringTable. The RString need not be closed, but closing is harmless.

Parameters

RString & aUri

The associated namespace for this string dictionary.

PublicIdentifier(RString &)

void

PublicIdentifier

(

RString &

aPubId

)

[pure virtual]

This method obtains the public identifier from the StringTable. Either the formal or non formal public id will do. The stringDictionary .rss files must list both these as wbxml documents have one or the other.

Parameters

RString & aPubId

The public identifier for this string dictionary.

Release()

void

Release

(

)

[pure virtual]

This method allows for the correct destrution of the string dictionary plugin.

Post-condition: the objects memory is cleaned up.

SwitchCodePage(TInt)

TInt

SwitchCodePage

(

TInt

aCodePage

)

[pure virtual]

This method switches the dictionary to use the specified codepage.

Parameters

TInt aCodePage

The code page to switch to.