/*
    This file is part of the KContacts framework.
    SPDX-FileCopyrightText: 2015-2019 Laurent Montel <montel@kde.org>

    SPDX-License-Identifier: LGPL-2.0-or-later
*/

#ifndef LANG_H
#define LANG_H

#include "kcontacts_export.h"

#include <QMap>
#include <QSharedDataPointer>
#include <QString>

class LangTest;

namespace KContacts
{
class ParameterMap;

/*!
 * \class KContacts::Lang
 * \inheaderfile KContacts/Lang
 * \inmodule KContacts
 *
 * \brief Class that holds a Language for a contact.
 * \since 4.14.5
 */
class KCONTACTS_EXPORT Lang
{
    friend KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &, const Lang &);
    friend KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &, Lang &);
    friend class Addressee;
    friend class VCardTool;
    friend class ::LangTest;

public:
    /*!
     */
    Lang();

    Lang(const Lang &other);

    /*!
     */
    Lang(const QString &language);

    ~Lang();

    /*!
     */
    typedef QList<Lang> List;

    /*!
     */
    void setLanguage(const QString &lang);

    /*!
     */
    Q_REQUIRED_RESULT QString language() const;

    /*!
     */
    Q_REQUIRED_RESULT bool isValid() const;

    /*!
     */
    Q_REQUIRED_RESULT bool operator==(const Lang &other) const;

    /*!
     */
    Q_REQUIRED_RESULT bool operator!=(const Lang &other) const;

    Lang &operator=(const Lang &other);

    /*!
     */
    Q_REQUIRED_RESULT QString toString() const;

private:
    // exported for LangTest
    void setParams(const ParameterMap &params);
    Q_REQUIRED_RESULT ParameterMap params() const;

    class Private;
    QSharedDataPointer<Private> d;
};

/*!
 * \relates KContacts::Lang
 */
KCONTACTS_EXPORT QDataStream &operator<<(QDataStream &stream, const Lang &object);

/*!
 * \relates KContacts::Lang
 */
KCONTACTS_EXPORT QDataStream &operator>>(QDataStream &stream, Lang &object);
}
Q_DECLARE_TYPEINFO(KContacts::Lang, Q_RELOCATABLE_TYPE);
#endif // LANG_H