summaryrefslogtreecommitdiffstats
path: root/tdecore/kcatalogue.h
diff options
context:
space:
mode:
authorTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-06 15:56:40 -0600
committerTimothy Pearson <kb9vqf@pearsoncomputing.net>2011-11-06 15:56:40 -0600
commite16866e072f94410321d70daedbcb855ea878cac (patch)
treeee3f52eabde7da1a0e6ca845fb9c2813cf1558cf /tdecore/kcatalogue.h
parenta58c20c1a7593631a1b50213c805507ebc16adaf (diff)
downloadtdelibs-e16866e072f94410321d70daedbcb855ea878cac.tar.gz
tdelibs-e16866e072f94410321d70daedbcb855ea878cac.zip
Actually move the kde files that were renamed in the last commit
Diffstat (limited to 'tdecore/kcatalogue.h')
-rw-r--r--tdecore/kcatalogue.h129
1 files changed, 129 insertions, 0 deletions
diff --git a/tdecore/kcatalogue.h b/tdecore/kcatalogue.h
new file mode 100644
index 000000000..0658b9000
--- /dev/null
+++ b/tdecore/kcatalogue.h
@@ -0,0 +1,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 "kdelibs_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 KLocale
+ */
+//REVISED: hausmann
+class KDECORE_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 kdelibs.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