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
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
|
/* This file is part of the KDE libraries
Copyright (c) 2001 Hans Petter Bieker <bieker@kde.org>
This library is free software; you can redistribute it and/or
modify it under the terms of the GNU Library General Public
License as published by the Free Software Foundation; either
version 2 of the License, or (at your option) any later version.
This library is distributed in the hope that it will be useful,
but WITHOUT ANY WARRANTY; without even the implied warranty of
MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE. See the GNU
Library General Public License for more details.
You should have received a copy of the GNU Library General Public License
along with this library; see the file COPYING.LIB. If not, write to
the Free Software Foundation, Inc., 51 Franklin Street, Fifth Floor,
Boston, MA 02110-1301, USA.
*/
#ifndef KCATALOGUE_H
#define KCATALOGUE_H
#include <tqstring.h>
#include "tdelibs_export.h"
struct kde_loaded_l10nfile;
class KCataloguePrivate;
/**
* This class abstracts a gettext message catalog. It will take care of
* opening the file and reading the catalog.
*
* @see TDELocale
*/
//REVISED: hausmann
class TDECORE_EXPORT KCatalogue
{
public:
/**
* Constructor.
*
* @param name The name of the catalog
* @param language The language of this catalog
*/
explicit KCatalogue(const TQString & name = TQString::null, const TQString & language = TQString::null);
/**
* Copy constructor.
*/
KCatalogue(const KCatalogue & rhs);
/**
* Assignment operator.
*/
KCatalogue & operator = ( const KCatalogue & rhs);
/**
* Destructor.
*/
virtual ~KCatalogue();
/**
* Returns the name of the catalog.
*
* @return The name of the catalog
*/
TQString name() const;
/**
* Returns the language of the catalog.
*
* @return The language of the catalog
*/
TQString language() const;
/**
* Returns the plural type for the catalog. This type is based on the language of the catalog
and is cached for performance.
*
* @return The plural type for the catalog
*/
int pluralType() const;
/**
* Sets the plural type for the catalog. The caller has probably looked it up in a tdelibs.mo-catalog
* for the appropriate language
*
* @return The plural type for the catalog
*/
void setPluralType( int pluralType );
/**
* Retrieves a translation of the specified message id.
*
* Do not pass 0 or "" strings as message ids.
*
* @param msgid The message id
*
* @return The translated message, in utf8 encoding, or 0 if not found
*/
const char * translate( const char * msgid ) const;
private:
/**
* @internal Changes the current file name.
*
* @param fileName The new file name
*/
void setFileName( const TQString & fileName );
/**
* @internal Retrieves the current file name.
*
* @return The current file name, if any.
*/
TQString fileName() const;
/**
* @internal Unloads the current file.
*/
void doUnload();
private:
KCataloguePrivate * d;
};
#endif
|
