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, 0 insertions, 93 deletions
diff --git a/doc/api-documentation/man/man3/swlocale.3 b/doc/api-documentation/man/man3/swlocale.3
deleted file mode 100644
index 6d65150..0000000
--- a/doc/api-documentation/man/man3/swlocale.3
+++ /dev/null
@@ -1,93 +0,0 @@
-.TH "SWLocale" 3 "5 Oct 2001" "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>\fR
-.PP
-.SS Public Methods
-
-.in +1c
-.ti -1c
-.RI "\fBSWLocale\fR (const char *ifilename)"
-.br
-.ti -1c
-.RI "virtual \fB~SWLocale\fR ()"
-.br
-.ti -1c
-.RI "virtual const char* \fBgetName\fR ()"
-.br
-.RI "\fIThis function is used to get the name of the languages which this object is handling.\fR"
-.ti -1c
-.RI "virtual const char* \fBgetDescription\fR ()"
-.br
-.ti -1c
-.RI "virtual const char* \fBtranslate\fR (const char *text)"
-.br
-.ti -1c
-.RI "virtual SWLocale& \fBoperator+=\fR (SWLocale &addFrom)"
-.br
-.ti -1c
-.RI "virtual const struct abbrev* \fBgetBookAbbrevs\fR ()"
-.br
-.ti -1c
-.RI "virtual void \fBgetBooks\fR (char **iBMAX, struct sbook ***ibooks)"
-.br
-.in -1c
-.SS Private Attributes
-
-.in +1c
-.ti -1c
-.RI "LookupMap \fBlookupTable\fR"
-.br
-.ti -1c
-.RI "\fBSWConfig\fR* \fBlocaleSource\fR"
-.br
-.ti -1c
-.RI "char* \fBname\fR"
-.br
-.ti -1c
-.RI "char* \fBdescription\fR"
-.br
-.ti -1c
-.RI "struct abbrev* \fBbookAbbrevs\fR"
-.br
-.ti -1c
-.RI "char* \fBBMAX\fR"
-.br
-.ti -1c
-.RI "struct sbook** \fBbooks\fR"
-.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: \fR
-.in +1c
-getname of this class. Another functions useful for frontend developers is , \fBgetDescription\fR.
-.PP
-Definition at line 44 of file swlocale.h.
-.SH MEMBER FUNCTION DOCUMENTATION
-.PP
-.SS const char * SWLocale::getDescription ()\fC [virtual]\fR
-.PP
-\fBReturns: \fR
-.in +1c
-The description. A possible example is "German".
-.SS const char * SWLocale::getName ()\fC [virtual]\fR
-.PP
-This function is used to get the name of the languages which this object is handling.
-.PP
-\fBReturns: \fR
-.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