Xml::RStringDictionaryCollectionImpl Class Reference

class Xml::RStringDictionaryCollectionImpl

The RStringDictionaryCollectionImpl class hides the implementation of the RStringDictionaryCollection .

It is responsible for maintaining the list of string dictionary plugins required by the framework.

Constructor & Destructor Documentation

RStringDictionaryCollectionImpl()

RStringDictionaryCollectionImpl ( )

Default constructor

Post-condition
This object is properly constructed.

RStringDictionaryCollectionImpl(const RStringDictionaryCollectionImpl &)

RStringDictionaryCollectionImpl ( const RStringDictionaryCollectionImpl & aOriginal ) [private]

Parameters

const RStringDictionaryCollectionImpl & aOriginal

Member Functions Documentation

Close()

TInt Close ( )

This method cleans up the object before destruction. It releases all resources in accordance to the R Class pattern.

Post-condition
This object may be allowed to go out of scope.

ConstructDictionaryL(const TDesC8 &, RStringPool &)

MStringDictionary * ConstructDictionaryL ( const TDesC8 & aDictionaryUri,
RStringPool & aStringPool
) [private]

This method constructs a StringDictionary.

leave
KErrXmlDictionaryPluginNotFound If ECom fails to find the object a leave occurs.

Parameters

const TDesC8 & aDictionaryUri The uri of this Dictionary.
RStringPool & aStringPool Contains the RTable for this Dictionary

CurrentDictionaryL()

MStringDictionary & CurrentDictionaryL ( ) const

This method obtains the current string dictionary in use. Also, serves as a way to test if any dictionaries have been loaded as none needs be.

leave
KErrXmlMissingStringDictionary if there is no dictionary

DestroyMapping(TAny *)

void DestroyMapping ( TAny * aPtr ) [private, static]

Tidy memory associated with this object.

Parameters

TAny * aPtr The StringDictionary pointer.

LocateDictionary(const RString &, MStringDictionary *&)

TBool LocateDictionary ( const RString & aNsUri,
MStringDictionary *& aStringDictionary
) [private]

This method locates an existing loaded Dictionary by it uri name.

Parameters

const RString & aNsUri The Dictionary uri.
MStringDictionary *& aStringDictionary On return, points to the requested Dictionary.

OpenDictionaryL(const TDesC8 &)

void OpenDictionaryL ( const TDesC8 & aDictionaryDescription )

This method loads the Dictionary.

Pre-condition
Connect has been called.
Post-condition
The Dictionary has been loaded.

Parameters

const TDesC8 & aDictionaryDescription The Namepspace MIME type.

OpenL()

void OpenL ( )

This method opens this resource incrementing the reference count. It must be the first method called after construction.

Post-condition
The object is ready to be used.

StringPool()

RStringPool & StringPool ( )

This method obtains a handle to the RStringPool

operator=(const RStringDictionaryCollectionImpl &)

RStringDictionaryCollectionImpl & operator= ( const RStringDictionaryCollectionImpl & aRhs ) [private]

Parameters

const RStringDictionaryCollectionImpl & aRhs

Member Data Documentation

RPointerArray< TDtorMapping > iDtorKeyAndDictionaryList

RPointerArray < TDtorMapping > iDtorKeyAndDictionaryList [private]

TInt iRefCount

TInt iRefCount [private]

The reference count for this collection.

MStringDictionary * iStringDictionary

MStringDictionary * iStringDictionary [private]

The current Dictionary in use. We do not own this; for quick access only.

RStringPool iStringPool

RStringPool iStringPool [private]

The StringPool for the Collection.