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.3161
1 files changed, 0 insertions, 161 deletions
diff --git a/doc/api-documentation/man/man3/localemgr.3 b/doc/api-documentation/man/man3/localemgr.3
deleted file mode 100644
index 90da5d7..0000000
--- a/doc/api-documentation/man/man3/localemgr.3
+++ /dev/null
@@ -1,161 +0,0 @@
-.TH "LocaleMgr" 3 "5 Oct 2001" "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>\fR
-.PP
-.SS Public Methods
-
-.in +1c
-.ti -1c
-.RI "\fBLocaleMgr\fR (const char *iConfigPath=0)"
-.br
-.RI "\fIDefault constructor of LocaleMgr You do normally not need this constructor, use \fBLocaleMgr::systemLocaleMgr\fR instead.\fR"
-.ti -1c
-.RI "virtual \fB~LocaleMgr\fR ()"
-.br
-.RI "\fIDefault destructor of LocaleMgr.\fR"
-.ti -1c
-.RI "virtual \fBSWLocale\fR* \fBgetLocale\fR (const char *name)"
-.br
-.RI "\fIGet the locale connected with the name "name".\fR"
-.ti -1c
-.RI "virtual list< string > \fBgetAvailableLocales\fR ()"
-.br
-.RI "\fIGet the list of available locales.\fR"
-.ti -1c
-.RI "virtual const char* \fBtranslate\fR (const char *name, const char *text)"
-.br
-.RI "\fIReturns translated text.\fR"
-.ti -1c
-.RI "virtual const char* \fBgetDefaultLocaleName\fR ()"
-.br
-.RI "\fIGet the default locale name.\fR"
-.ti -1c
-.RI "virtual void \fBsetDefaultLocaleName\fR (const char *name)"
-.br
-.RI "\fISet the new standard locale of Sword.\fR"
-.in -1c
-.SS Static Public Attributes
-
-.in +1c
-.ti -1c
-.RI "LocaleMgr \fBsystemLocaleMgr\fR"
-.br
-.RI "\fIThe LocaleMgr object used globally in the Sword world.\fR"
-.in -1c
-.SS Protected Methods
-
-.in +1c
-.ti -1c
-.RI "virtual void \fBloadConfigDir\fR (const char *ipath)"
-.br
-.in -1c
-.SS Protected Attributes
-
-.in +1c
-.ti -1c
-.RI "LocaleMap \fBlocales\fR"
-.br
-.in -1c
-.SS Private Methods
-
-.in +1c
-.ti -1c
-.RI "void \fBdeleteLocales\fR ()"
-.br
-.in -1c
-.SS Private Attributes
-
-.in +1c
-.ti -1c
-.RI "char* \fBdefaultLocaleName\fR"
-.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: \fR
-.in +1c
-\fBgetDefaultLocaleName\fR To set the default locale name use , \fBsetDefaultLocaleName\fR To get the locale for a language name use , \fBgetLocale\fR To get a list of availble locales use , \fBgetAvailableLocales\fR
-.PP
-Definition at line 49 of file localemgr.h.
-.SH MEMBER FUNCTION DOCUMENTATION
-.PP
-.SS list< string > LocaleMgr::getAvailableLocales ()\fC [virtual]\fR
-.PP
-Get the list of available locales.
-.PP
-@ret Returns a list of strings, which contains the names of the available locales.
-.SS const char * LocaleMgr::getDefaultLocaleName ()\fC [virtual]\fR
-.PP
-Get the default locale name.
-.PP
-To set it use
-.PP
-\fBSee also: \fR
-.in +1c
-\fBsetDefaultLocaleName\fR
-.PP
-@ret Returns the default locale name
-.SS \fBSWLocale\fR * LocaleMgr::getLocale (const char * name)\fC [virtual]\fR
-.PP
-Get the locale connected with the name "name".
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIname\fR\fR
-The name of the locale you want to have. For example use getLocale("de") to get the locale for the German language.
-.PP
-\fBReturns: \fR
-.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 void LocaleMgr::setDefaultLocaleName (const char * name)\fC [virtual]\fR
-.PP
-Set the new standard locale of Sword.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIname\fR\fR
-The name of the new default locale
-.SS const char * LocaleMgr::translate (const char * name, const char * text)\fC [virtual]\fR
-.PP
-Returns translated text.
-.PP
-This function uses both parameters to return the translated version of the given text.
-.PP
-\fBParameters: \fR
-.in +1c
-.TP
-\fB\fIname\fR\fR
-The name of the locale Sword should use
-.PP
-\fBan The text to translate into the language given by the first parameter.\fR
-.in +1c
-\fBReturns: \fR
-.in +1c
-Returns the translated text.
-.SH MEMBER DATA DOCUMENTATION
-.PP
-.SS LocaleMgr LocaleMgr::systemLocaleMgr\fC [static]\fR
-.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