summaryrefslogtreecommitdiff
path: root/doc/api-documentation/man/man3/LocaleMgr.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/man/man3/LocaleMgr.3')
-rw-r--r--doc/api-documentation/man/man3/LocaleMgr.3163
1 files changed, 0 insertions, 163 deletions
diff --git a/doc/api-documentation/man/man3/LocaleMgr.3 b/doc/api-documentation/man/man3/LocaleMgr.3
deleted file mode 100644
index 64c38bb..0000000
--- a/doc/api-documentation/man/man3/LocaleMgr.3
+++ /dev/null
@@ -1,163 +0,0 @@
-.TH "LocaleMgr" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*-
-.ad l
-.nh
-.SH NAME
-LocaleMgr \- The LocaleMgr class handles all the different locales of Sword.
-.SH SYNOPSIS
-.br
-.PP
-\fC#include <localemgr.h>\fP
-.PP
-.SS "Public Methods"
-
-.in +1c
-.ti -1c
-.RI "\fBLocaleMgr\fP (const char *iConfigPath=0)"
-.br
-.RI "\fIDefault constructor of LocaleMgr You do normally not need this constructor, use \fBLocaleMgr::systemLocaleMgr\fP instead.\fP"
-.ti -1c
-.RI "virtual \fB~LocaleMgr\fP ()"
-.br
-.RI "\fIDefault destructor of LocaleMgr.\fP"
-.ti -1c
-.RI "virtual \fBSWLocale\fP * \fBgetLocale\fP (const char *name)"
-.br
-.RI "\fIGet the locale connected with the name 'name'.\fP"
-.ti -1c
-.RI "virtual list< string > \fBgetAvailableLocales\fP ()"
-.br
-.RI "\fIGet the list of available locales.\fP"
-.ti -1c
-.RI "virtual const char * \fBtranslate\fP (const char *name, const char *text)"
-.br
-.RI "\fIReturns translated text.\fP"
-.ti -1c
-.RI "virtual const char * \fBgetDefaultLocaleName\fP ()"
-.br
-.RI "\fIGet the default locale name.\fP"
-.ti -1c
-.RI "virtual void \fBsetDefaultLocaleName\fP (const char *name)"
-.br
-.RI "\fISet the new standard locale of Sword.\fP"
-.in -1c
-.SS "Static Public Attributes"
-
-.in +1c
-.ti -1c
-.RI "LocaleMgr \fBsystemLocaleMgr\fP"
-.br
-.RI "\fIThe LocaleMgr object used globally in the Sword world.\fP"
-.in -1c
-.SS "Protected Methods"
-
-.in +1c
-.ti -1c
-.RI "virtual void \fBloadConfigDir\fP (const char *ipath)"
-.br
-.in -1c
-.SS "Protected Attributes"
-
-.in +1c
-.ti -1c
-.RI "LocaleMap \fBlocales\fP"
-.br
-.in -1c
-.SS "Private Methods"
-
-.in +1c
-.ti -1c
-.RI "void \fBdeleteLocales\fP ()"
-.br
-.in -1c
-.SS "Private Attributes"
-
-.in +1c
-.ti -1c
-.RI "char * \fBdefaultLocaleName\fP"
-.br
-.in -1c
-.SH "DETAILED DESCRIPTION"
-.PP
-The LocaleMgr class handles all the different locales of Sword.
-.PP
-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.
-.PP
-To get the default locale name use
-.PP
-\fBSee also: \fP
-.in +1c
-\fBgetDefaultLocaleName\fP To set the default locale name use , \fBsetDefaultLocaleName\fP To get the locale for a language name use , \fBgetLocale\fP To get a list of availble locales use , \fBgetAvailableLocales\fP
-.PP
-Definition at line 49 of file localemgr.h.
-.SH "MEMBER FUNCTION DOCUMENTATION"
-.PP
-.SS "virtual list< string > LocaleMgr::getAvailableLocales ()\fC [virtual]\fP"
-.PP
-Get the list of available locales.
-.PP
-@ret Returns a list of strings, which contains the names of the available locales.
-.SS "virtual const char* LocaleMgr::getDefaultLocaleName ()\fC [virtual]\fP"
-.PP
-Get the default locale name.
-.PP
-To set it use
-.PP
-\fBSee also: \fP
-.in +1c
-\fBsetDefaultLocaleName\fP
-.PP
-@ret Returns the default locale name
-.SS "virtual \fBSWLocale\fP* LocaleMgr::getLocale (const char * name)\fC [virtual]\fP"
-.PP
-Get the locale connected with the name 'name'.
-.PP
-Parameters:
-.in +1c
-.TP
-\fB\fIname\fP\fP
-The name of the locale you want to have. For example use getLocale('de') to get the locale for the German language.
-.PP
-\fBReturns: \fP
-.in +1c
-Returns the locale object if the locale with the name given as parameter was found. If it wasn't found return NULL.
-.SS "virtual void LocaleMgr::setDefaultLocaleName (const char * name)\fC [virtual]\fP"
-.PP
-Set the new standard locale of Sword.
-.PP
-Parameters:
-.in +1c
-.TP
-\fB\fIname\fP\fP
-The name of the new default locale
-.SS "virtual const char* LocaleMgr::translate (const char * name, const char * text)\fC [virtual]\fP"
-.PP
-Returns translated text.
-.PP
-This function uses both parameters to return the translated version of the given text.
-.PP
-Parameters:
-.in +1c
-.TP
-\fB\fIname\fP\fP
-The name of the locale Sword should use
-.PP
-\fBan The text to translate into the language given by the first parameter.\fP
-.in +1c
-
-.PP
-\fBReturns: \fP
-.in +1c
-Returns the translated text.
-.SH "MEMBER DATA DOCUMENTATION"
-.PP
-.SS "LocaleMgr LocaleMgr::systemLocaleMgr\fC [static]\fP"
-.PP
-The LocaleMgr object used globally in the Sword world.
-.PP
-Do not create your own LocaleMgr, use this static object instead.
-.PP
-Definition at line 107 of file localemgr.h.
-
-.SH "AUTHOR"
-.PP
-Generated automatically by Doxygen for The Sword Project from the source code. \ No newline at end of file