---

sword::LocaleMgr Class Reference

The LocaleMgr class handles all the different locales of Sword. More...

#include <localemgr.h>

List of all members.

Public Member Functions
	LocaleMgr (const char *iConfigPath=0)
	Default constructor of LocaleMgr You do normally not need this constructor, use LocaleMgr::systemLocaleMgr instead.
virtual	~LocaleMgr ()
	Default destructor of LocaleMgr.
virtual SWLocale *	getLocale (const char *name)
	Get the locale connected with the name "name".
virtual std::list< std::string >	getAvailableLocales ()
	Get the list of available locales.
virtual const char *	translate (const char *text, const char *localeName=0)
	Returns translated text.
virtual const char *	getDefaultLocaleName ()
	Get the default locale name.
virtual void	setDefaultLocaleName (const char *name)
	Set the new standard locale of Sword.
virtual void	loadConfigDir (const char *ipath)
	Augment this localmgr with all locale.conf files in a directory.
Static Public Attributes
LocaleMgr	systemLocaleMgr
	The LocaleMgr object used globally in the Sword world.
Protected Attributes
LocaleMap	locales
Private Member Functions
void	deleteLocales ()
	LocaleMgr (const LocaleMgr &)
Private Attributes
char *	defaultLocaleName

---

Detailed Description

The LocaleMgr class handles all the different locales of Sword.

It provides functions to get a list of all available locales, to get the default locale name and to get it. The other functions are not interesting for frontend programmers.

To get the default locale name use

See also:

getDefaultLocaleName To set the default locale name use

setDefaultLocaleName To get the locale for a language name use

getLocale To get a list of availble locales use

getAvailableLocales

---

Member Function Documentation

std::list< std::string > sword::LocaleMgr::getAvailableLocales (    )  [virtual]

Get the list of available locales. Returns: Returns a list of strings, which contains the names of the available locales.

const char * sword::LocaleMgr::getDefaultLocaleName (    )  [virtual]

Get the default locale name. To set it use See also: setDefaultLocaleName Returns: Returns the default locale name

SWLocale * sword::LocaleMgr::getLocale (  const char *    name )  [virtual]

Get the locale connected with the name "name". Parameters: name  The name of the locale you want to have. For example use getLocale("de") to get the locale for the German language. Returns: Returns the locale object if the locale with the name given as parameter was found. If it wasn't found return NULL.

void sword::LocaleMgr::setDefaultLocaleName (  const char *    name )  [virtual]

Set the new standard locale of Sword. Parameters: name  The name of the new default locale

const char * sword::LocaleMgr::translate (  const char *    text, const char *    localeName = 0 )  [virtual]

Returns translated text. This function uses both parameters to return the translated version of the given text. Parameters: text  The text to translate into the language given by the first parameter. localeName  The name of the locale Sword should use Returns: Returns the translated text.

---

Member Data Documentation

LocaleMgr sword::LocaleMgr::systemLocaleMgr [static]

The LocaleMgr object used globally in the Sword world. Do not create your own LocaleMgr, use this static object instead.

---

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

• localemgr.h
• localemgr.cpp

---