1 2 3 4 5 6 7 8 9 10 11 12 13 14 15 16 17 18 19 20 21 22 23 24 25 26 27 28 29 30 31 32 33 34 35 36 37 38 39 40 41 42 43 44 45 46 47 48 49 50 51 52 53 54 55 56 57 58 59 60 61 62 63 64 65 66 67 68 69 70 71 72 73 74 75 76 77 78 79 80 81 82 83 84 85 86 87 88 89 90 91 92 93
|
.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.
|