\section{KCatalogue Class Reference}
\label{classKCatalogue}\index{KCatalogue@{KCatalogue}}
This class abstracts a gettext message catalogue.  


{\tt \#include $<$kcatalogue.h$>$}

\subsection*{Public Member Functions}
\begin{CompactItemize}
\item 
{\bf KCatalogue} (const  {\bf QString} \&name=QString::null)
\begin{CompactList}\small\item\em Constructor. \item\end{CompactList}\item 
{\bf KCatalogue} (const  {\bf KCatalogue} \&rhs)
\begin{CompactList}\small\item\em Copy constructor. \item\end{CompactList}\item 
{\bf KCatalogue} \& {\bf operator=} (const  {\bf KCatalogue} \&rhs)
\begin{CompactList}\small\item\em Assignment operator. \item\end{CompactList}\item 
virtual {\bf $\sim$KCatalogue} ()
\begin{CompactList}\small\item\em Destructor. \item\end{CompactList}\item 
{\bf QString} {\bf name} () const 
\begin{CompactList}\small\item\em Returns the name of the catalogue. \item\end{CompactList}\item 
void {\bf set\-File\-Name} (const  {\bf QString} \&file\-Name)
\begin{CompactList}\small\item\em Changes the current file name. \item\end{CompactList}\item 
const  char $\ast$ {\bf translate} (const  char $\ast$msgid) const 
\begin{CompactList}\small\item\em Retrieves a translation of the specified message id. \item\end{CompactList}\end{CompactItemize}


\subsection{Detailed Description}
This class abstracts a gettext message catalogue. 

It will take care of opening the file and reading the catalogue.

\begin{Desc}
\item[See also:]{\bf KLocale}{\rm (p.\,\pageref{classKLocale})} \end{Desc}




Definition at line 36 of file kcatalogue.h.

\subsection{Constructor \& Destructor Documentation}
\index{KCatalogue@{KCatalogue}!KCatalogue@{KCatalogue}}
\index{KCatalogue@{KCatalogue}!KCatalogue@{KCatalogue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KCatalogue::KCatalogue (const {\bf QString} \& {\em name} = QString::null)\hspace{0.3cm}{\tt  [explicit]}}\label{classKCatalogue_a0}


Constructor. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em name}]The name of the catalogue \end{description}
\end{Desc}


Definition at line 52 of file kcatalogue.cpp.

References name().\index{KCatalogue@{KCatalogue}!KCatalogue@{KCatalogue}}
\index{KCatalogue@{KCatalogue}!KCatalogue@{KCatalogue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KCatalogue::KCatalogue (const {\bf KCatalogue} \& {\em rhs})}\label{classKCatalogue_a1}


Copy constructor. 



Definition at line 58 of file kcatalogue.cpp.\index{KCatalogue@{KCatalogue}!~KCatalogue@{$\sim$KCatalogue}}
\index{~KCatalogue@{$\sim$KCatalogue}!KCatalogue@{KCatalogue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}KCatalogue::$\sim${\bf KCatalogue} ()\hspace{0.3cm}{\tt  [virtual]}}\label{classKCatalogue_a3}


Destructor. 



Definition at line 72 of file kcatalogue.cpp.

\subsection{Member Function Documentation}
\index{KCatalogue@{KCatalogue}!operator=@{operator=}}
\index{operator=@{operator=}!KCatalogue@{KCatalogue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf KCatalogue} \& KCatalogue::operator= (const {\bf KCatalogue} \& {\em rhs})}\label{classKCatalogue_a2}


Assignment operator. 



Definition at line 64 of file kcatalogue.cpp.

References d, file\-Name(), and set\-File\-Name().\index{KCatalogue@{KCatalogue}!name@{name}}
\index{name@{name}!KCatalogue@{KCatalogue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}{\bf QString} KCatalogue::name () const}\label{classKCatalogue_a4}


Returns the name of the catalogue. 

\begin{Desc}
\item[Returns:]The name of the catalogue \end{Desc}


Definition at line 79 of file kcatalogue.cpp.

Referenced by KCatalogue().\index{KCatalogue@{KCatalogue}!setFileName@{setFileName}}
\index{setFileName@{setFileName}!KCatalogue@{KCatalogue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}void KCatalogue::set\-File\-Name (const {\bf QString} \& {\em file\-Name})}\label{classKCatalogue_a5}


Changes the current file name. 

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em file\-Name}]The new file name \end{description}
\end{Desc}


Definition at line 84 of file kcatalogue.cpp.

References QFile::encode\-Name(), QString::is\-Empty(), and QCString::length().

Referenced by operator=().\index{KCatalogue@{KCatalogue}!translate@{translate}}
\index{translate@{translate}!KCatalogue@{KCatalogue}}
\subsubsection{\setlength{\rightskip}{0pt plus 5cm}const  char $\ast$ KCatalogue::translate (const char $\ast$ {\em msgid}) const}\label{classKCatalogue_a6}


Retrieves a translation of the specified message id. 

Do not pass 0 or \char`\"{}\char`\"{} strings as message ids.

\begin{Desc}
\item[Parameters:]
\begin{description}
\item[{\em msgid}]The message id\end{description}
\end{Desc}
\begin{Desc}
\item[Returns:]The translated message, in utf8 encoding, or 0 if not found \end{Desc}


Definition at line 107 of file kcatalogue.cpp.

The documentation for this class was generated from the following files:\begin{CompactItemize}
\item 
kcatalogue.h\item 
kcatalogue.cpp\end{CompactItemize}
