.TH "KCatalogue" 3 "28 Jan 2004" "kdecore Library" \" -*- nroff -*-
.ad l
.nh
.SH NAME
KCatalogue \- This class abstracts a gettext message catalogue.  

.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)"
.br
.RI "\fIConstructor. \fP"
.ti -1c
.RI "\fBKCatalogue\fP (const  \fBKCatalogue\fP &rhs)"
.br
.RI "\fICopy constructor. \fP"
.ti -1c
.RI "\fBKCatalogue\fP & \fBoperator=\fP (const  \fBKCatalogue\fP &rhs)"
.br
.RI "\fIAssignment operator. \fP"
.ti -1c
.RI "virtual \fB~KCatalogue\fP ()"
.br
.RI "\fIDestructor. \fP"
.ti -1c
.RI "\fBQString\fP \fBname\fP () const "
.br
.RI "\fIReturns the name of the catalogue. \fP"
.ti -1c
.RI "void \fBsetFileName\fP (const  \fBQString\fP &fileName)"
.br
.RI "\fIChanges the current file name. \fP"
.ti -1c
.RI "const  char * \fBtranslate\fP (const  char *msgid) const "
.br
.RI "\fIRetrieves a translation of the specified message id. \fP"
.in -1c
.SH "Detailed Description"
.PP 
This class abstracts a gettext message catalogue. 

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

.PP
Definition at line 36 of file kcatalogue.h.
.SH "Constructor & Destructor Documentation"
.PP 
.SS "KCatalogue::KCatalogue (const \fBQString\fP & name = QString::null)\fC [explicit]\fP"
.PP
Constructor. \fBParameters:\fP
.RS 4
\fIname\fP The name of the catalogue 
.RE
.PP
Definition at line 52 of file kcatalogue.cpp.
.PP
References name().
.SS "KCatalogue::KCatalogue (const \fBKCatalogue\fP & rhs)"
.PP
Copy constructor. Definition at line 58 of file kcatalogue.cpp.
.SS "KCatalogue::~\fBKCatalogue\fP ()\fC [virtual]\fP"
.PP
Destructor. Definition at line 72 of file kcatalogue.cpp.
.SH "Member Function Documentation"
.PP 
.SS "\fBKCatalogue\fP & KCatalogue::operator= (const \fBKCatalogue\fP & rhs)"
.PP
Assignment operator. Definition at line 64 of file kcatalogue.cpp.
.PP
References d, fileName(), and setFileName().
.SS "\fBQString\fP KCatalogue::name () const"
.PP
Returns the name of the catalogue. \fBReturns:\fP
.RS 4
The name of the catalogue 
.RE
.PP
Definition at line 79 of file kcatalogue.cpp.
.PP
Referenced by KCatalogue().
.SS "void KCatalogue::setFileName (const \fBQString\fP & fileName)"
.PP
Changes the current file name. \fBParameters:\fP
.RS 4
\fIfileName\fP The new file name 
.RE
.PP
Definition at line 84 of file kcatalogue.cpp.
.PP
References QFile::encodeName(), QString::isEmpty(), and QCString::length().
.PP
Referenced by operator=().
.SS "const  char * KCatalogue::translate (const char * msgid) const"
.PP
Retrieves a translation of the specified message id. 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
Definition at line 107 of file kcatalogue.cpp.

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