summaryrefslogtreecommitdiff
path: root/doc/api-documentation/man/man3/SWLocale.3
diff options
context:
space:
mode:
Diffstat (limited to 'doc/api-documentation/man/man3/SWLocale.3')
-rw-r--r--doc/api-documentation/man/man3/SWLocale.393
1 files changed, 93 insertions, 0 deletions
diff --git a/doc/api-documentation/man/man3/SWLocale.3 b/doc/api-documentation/man/man3/SWLocale.3
new file mode 100644
index 0000000..e7dcb2c
--- /dev/null
+++ b/doc/api-documentation/man/man3/SWLocale.3
@@ -0,0 +1,93 @@
+.TH "SWLocale" 3 "22 Jan 2002" "The Sword Project" \" -*- nroff -*-
+.ad l
+.nh
+.SH NAME
+SWLocale \- SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language.
+.SH SYNOPSIS
+.br
+.PP
+\fC#include <swlocale.h>\fP
+.PP
+.SS "Public Methods"
+
+.in +1c
+.ti -1c
+.RI "\fBSWLocale\fP (const char *ifilename)"
+.br
+.ti -1c
+.RI "virtual \fB~SWLocale\fP ()"
+.br
+.ti -1c
+.RI "virtual const char * \fBgetName\fP ()"
+.br
+.RI "\fIThis function is used to get the name of the languages which this object is handling.\fP"
+.ti -1c
+.RI "virtual const char * \fBgetDescription\fP ()"
+.br
+.ti -1c
+.RI "virtual const char * \fBtranslate\fP (const char *text)"
+.br
+.ti -1c
+.RI "virtual SWLocale & \fBoperator+=\fP (SWLocale &addFrom)"
+.br
+.ti -1c
+.RI "virtual const struct abbrev * \fBgetBookAbbrevs\fP ()"
+.br
+.ti -1c
+.RI "virtual void \fBgetBooks\fP (char **iBMAX, struct sbook ***ibooks)"
+.br
+.in -1c
+.SS "Private Attributes"
+
+.in +1c
+.ti -1c
+.RI "LookupMap \fBlookupTable\fP"
+.br
+.ti -1c
+.RI "\fBSWConfig\fP * \fBlocaleSource\fP"
+.br
+.ti -1c
+.RI "char * \fBname\fP"
+.br
+.ti -1c
+.RI "char * \fBdescription\fP"
+.br
+.ti -1c
+.RI "abbrev * \fBbookAbbrevs\fP"
+.br
+.ti -1c
+.RI "char * \fBBMAX\fP"
+.br
+.ti -1c
+.RI "sbook ** \fBbooks\fP"
+.br
+.in -1c
+.SH "DETAILED DESCRIPTION"
+.PP
+SWLocale is used for the localisation of the booknames The SWLocale is a class which holds the information of one language.
+.PP
+Every language supported by Sword has one SWLocale object, get the name of the Language using
+.PP
+\fBSee also: \fP
+.in +1c
+getname of this class. Another functions useful for frontend developers is , \fBgetDescription\fP.
+.PP
+Definition at line 44 of file swlocale.h.
+.SH "MEMBER FUNCTION DOCUMENTATION"
+.PP
+.SS "virtual const char* SWLocale::getDescription ()\fC [virtual]\fP"
+.PP
+\fBReturns: \fP
+.in +1c
+The description. A possible example is 'German'.
+.SS "virtual const char* SWLocale::getName ()\fC [virtual]\fP"
+.PP
+This function is used to get the name of the languages which this object is handling.
+.PP
+\fBReturns: \fP
+.in +1c
+The name of the managed language. A possible example is 'de'.
+
+.SH "AUTHOR"
+.PP
+Generated automatically by Doxygen for The Sword Project from the source code. \ No newline at end of file