ktranslatable.h

Go to the documentation of this file.

/*
    This file is part of KNewStuff2.
    Copyright (c) 2006, 2007 Josef Spillner <spillner@kde.org>

    This library is free software; you can redistribute it and/or
    modify it under the terms of the GNU Lesser General Public
    License as published by the Free Software Foundation; either
    version 2.1 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
    Lesser General Public License for more details.

    You should have received a copy of the GNU Lesser General Public
    License along with this library.  If not, see <http://www.gnu.org/licenses/>.
*/
#ifndef KTRANSLATABLE_H
#define KTRANSLATABLE_H

#include <knewstuff2/knewstuff_export.h>

#include <QtCore/QString>
#include <QtCore/QMap>
#include <QtCore/QStringList>

namespace KNS
{

class KTranslatablePrivate;

class KNEWSTUFF_EXPORT KTranslatable
{
public:
    typedef QMap<QString, QString> Map;
    typedef QMapIterator<QString, QString> Iterator;

    KTranslatable();

    KTranslatable(const QString& string);

    KTranslatable& operator=(const KTranslatable&);
    KTranslatable(const KTranslatable&);
    ~KTranslatable();

    void addString(const QString& lang, const QString& string);

    QString representation() const;

    QString translated(const QString& lang) const;

    QStringList strings() const;

    QStringList languages() const;

    QString language() const;

    QMap<QString, QString> stringmap() const;

    bool isTranslated() const;

    bool isEmpty() const;
private:
    class KTranslatablePrivate* const d;

    QMap<QString, QString> m_strings;
};

}

#endif