.TH "KCatalogue" kde3 "11 Jun 2005" "Version Version 3.4.1" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KCatalogue \- This class abstracts a gettext message catalog.  

.PP
.SH SYNOPSIS
.br
.PP
\fC#include <kcatalogue.h>\fP
.PP
.SS "Public Member Functions"

.in +1c
.ti -1c
.RI "\fBKCatalogue\fP (const \fBQString\fP &name=QString::null, const \fBQString\fP &language=QString::null)"
.br
.ti -1c
.RI "\fBKCatalogue\fP (const \fBKCatalogue\fP &rhs)"
.br
.ti -1c
.RI "\fBKCatalogue\fP & \fBoperator=\fP (const \fBKCatalogue\fP &rhs)"
.br
.ti -1c
.RI "virtual \fB~KCatalogue\fP ()"
.br
.ti -1c
.RI "\fBQString\fP \fBname\fP () const "
.br
.ti -1c
.RI "\fBQString\fP \fBlanguage\fP () const "
.br
.ti -1c
.RI "int \fBpluralType\fP () const "
.br
.ti -1c
.RI "void \fBsetPluralType\fP (int pluralType)"
.br
.ti -1c
.RI "const char * \fBtranslate\fP (const char *msgid) const "
.br
.in -1c
.SH "Detailed Description"
.PP 
This class abstracts a gettext message catalog. 

It will take care of opening the file and reading the catalog.
.PP
\fBSee also:\fP
.RS 4
\fBKLocale\fP 
.RE
.PP

.PP
Definition at line 37 of file kcatalogue.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KCatalogue::KCatalogue (const \fBQString\fP & name = \fCQString::null\fP, const \fBQString\fP & language = \fCQString::null\fP)\fC [explicit]\fP"
.PP
Constructor. 
.PP
\fBParameters:\fP
.RS 4
\fIname\fP The name of the catalog 
.br
\fIlanguage\fP The language of this catalog 
.RE
.PP

.PP
Definition at line 55 of file kcatalogue.cpp.
.PP
References QString::arg(), QString::fromLatin1(), language(), and name().
.SS "KCatalogue::KCatalogue (const \fBKCatalogue\fP & rhs)"
.PP
Copy constructor. 
.PP
Definition at line 73 of file kcatalogue.cpp.
.SS "KCatalogue::~\fBKCatalogue\fP ()\fC [virtual]\fP"
.PP
Destructor. 
.PP
Definition at line 89 of file kcatalogue.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBKCatalogue\fP & KCatalogue::operator= (const \fBKCatalogue\fP & rhs)"
.PP
Assignment operator. 
.PP
Definition at line 79 of file kcatalogue.cpp.
.PP
References QString::d(), and name().
.SS "\fBQString\fP KCatalogue::name () const"
.PP
Returns the name of the catalog. 
.PP
\fBReturns:\fP
.RS 4
The name of the catalog 
.RE
.PP

.PP
Definition at line 96 of file kcatalogue.cpp.
.PP
Referenced by KCatalogue(), and operator=().
.SS "\fBQString\fP KCatalogue::language () const"
.PP
Returns the language of the catalog. 
.PP
\fBReturns:\fP
.RS 4
The language of the catalog 
.RE
.PP

.PP
Definition at line 101 of file kcatalogue.cpp.
.PP
Referenced by KCatalogue().
.SS "int KCatalogue::pluralType () const"
.PP
Returns the plural type for the catalog. 
.PP
This type is based on the language of the catalog and is cached for performance.
.PP
\fBReturns:\fP
.RS 4
The plural type for the catalog 
.RE
.PP

.PP
Definition at line 111 of file kcatalogue.cpp.
.SS "void KCatalogue::setPluralType (int pluralType)"
.PP
Sets the plural type for the catalog. 
.PP
The caller has probably looked it up in a kdelibs.mo-catalog for the appropriate language
.PP
\fBReturns:\fP
.RS 4
The plural type for the catalog 
.RE
.PP

.PP
Definition at line 106 of file kcatalogue.cpp.
.SS "const char * KCatalogue::translate (const char * msgid) const"
.PP
Retrieves a translation of the specified message id. 
.PP
Do not pass 0 or '' strings as message ids.
.PP
\fBParameters:\fP
.RS 4
\fImsgid\fP The message id
.RE
.PP
\fBReturns:\fP
.RS 4
The translated message, in utf8 encoding, or 0 if not found 
.RE
.PP

.PP
Definition at line 140 of file kcatalogue.cpp.

.SH "Author"
.PP 
Generated automatically by Doxygen for kdecore Library from the source code.
