Xml::RStringDictionaryCollection Class Reference

class Xml::RStringDictionaryCollection

The RStringDictionaryCollection class holds a collection of Dictionaries requested by the user.

Constructor & Destructor Documentation

RStringDictionaryCollection()

IMPORT_CRStringDictionaryCollection()

Default constructor

Post-condition
This object is properly constructed.

RStringDictionaryCollection(const RStringDictionaryCollection &)

RStringDictionaryCollection(const RStringDictionaryCollection &aOriginal)[private]

Parameters

const RStringDictionaryCollection & aOriginal

Member Functions Documentation

Close()

IMPORT_C voidClose()

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.

CreateImplL()

voidCreateImplL()[private]

Create the implementation object.

Pre-condition
The object has just been constructed but not opened.
Post-condition
The object is fully constructed and ready to be used.

CurrentDictionaryL()

IMPORT_C 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

OpenDictionaryL(const TDesC8 &)

IMPORT_C voidOpenDictionaryL(const TDesC8 &aDictionaryDescription)

This method loads the Dictionary.

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

Parameters

const TDesC8 & aDictionaryDescriptionThe Namepspace MIME type.

OpenL()

IMPORT_C voidOpenL()

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()

IMPORT_C RStringPool &StringPool()

This method obtains a handle to the RStringPool

operator=(const RStringDictionaryCollection &)

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

Parameters

const RStringDictionaryCollection & aRhs

Member Data Documentation

RStringDictionaryCollectionImpl * iImpl

RStringDictionaryCollectionImpl *iImpl[private]

Hide the implementation details.