#include <IStringDataBase.h>

Inheritance diagram for IStringDataBase:

Public Types
enum	{ kDefaultIID = IID_ISTRINGDATABASE }

Public Member Functions
virtual void	Add (const PMLocaleId &localeId, const PMString &key, const PMString &string, const PluginID &providingPlugin)=0

virtual bool16	Retrieve (const PMLocaleId &localeId, const PMString &key, PMString &string) const =0

virtual void	TurnOffMemoryPurge ()=0

virtual const IStringDataBaseTable *	GetStringTable (const PMLocaleId &locale) const =0

virtual void	InitializationComplete (const PMLocaleId &locale)=0

virtual void	Cleanup ()=0

virtual bool16	Retrieve (const PMLocaleId &localeId, ConstCString key, PMString &string) const =0

Public Member Functions inherited from IPMUnknown
virtual IPMUnknown *	QueryInterface (PMIID interfaceID) const =0

virtual void	AddRef () const =0

virtual void	Release () const =0

Detailed Description

Interface which holds table of key strings and localized strings and provides translation

Member Function Documentation

virtual void IStringDataBase::Add	(	const PMLocaleId &	localeId,
		const PMString &	key,
		const PMString &	string,
		const PluginID &	providingPlugin
	)

pure virtual

Add a new string to the string database

Parameters

localeId	specifies which language this string is for. Typically there's only a string database for 1 language per run.
key	untranslated keystring.
string	translated string for the language specified by localeId
providingPlugin	the id of the plugin providing this string. Just used to debug string collisions at the moment.

virtual void IStringDataBase::Cleanup ( )

pure virtual

Internal use only. Destroys string database.

virtual const IStringDataBaseTable* IStringDataBase::GetStringTable ( const PMLocaleId & locale ) const

pure virtual

Direct access to the string table for a specified locale. Returns a pointer to the string table for the specified locale. May return nil if a string table was not initialized for that locale. INTERNAL USE ONLY!

virtual void IStringDataBase::InitializationComplete ( const PMLocaleId & locale )

pure virtual

Notification when all strings for this locale have been added. Must be called before Retrieve.

virtual bool16 IStringDataBase::Retrieve	(	const PMLocaleId &	localeId,
		const PMString &	key,
		PMString &	string
	)		const

pure virtual

Look up a translation in the string database

Parameters

localeId	specifies which language you want the translation in. Only works if a string database for the language has been populated.
key	untranslated keystring.

Returns: translated string for the language specified by localeId

virtual bool16 IStringDataBase::Retrieve	(	const PMLocaleId &	localeId,
		ConstCString	key,
		PMString &	string
	)		const

pure virtual

Look up a translation in the string database

Parameters

localeId	specifies which language you want the translation in. Only works if a string database for the language has been populated.
key	untranslated keystring.

Returns: translated string for the language specified by localeId

virtual void IStringDataBase::TurnOffMemoryPurge ( )

pure virtual

Internal use only. Disables purging of the string database

Public Types

Public Member Functions

Detailed Description

Member Function Documentation