k4aboutdata.h

/*
 * This file is part of the KDE Libraries
 * Copyright (C) 2000 Espen Sand ([email protected])
 * Copyright (C) 2008 Friedrich W. H. Kossebau <[email protected]>
 * Copyright (C) 2010 Teo Mrnjavac <[email protected]>
 *
 * 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 K4ABOUTDATA_H
#define K4ABOUTDATA_H

#include <kdelibs4support_export.h>

#ifdef KDELIBS4SUPPORT_NO_DEPRECATED_NOISE
#warning "This file is deprecated."
#endif

#include <klocalizedstring.h>
// Qt
#include <QString>
#include <QSharedDataPointer>

template <class T> class QList;
class QVariant;
class KAboutData;
class K4AboutData;

class KDELIBS4SUPPORT_DEPRECATED_EXPORT_NOISE K4AboutPerson
{
    friend class K4AboutData;
public:
    KDELIBS4SUPPORT_DEPRECATED explicit K4AboutPerson(const KLocalizedString &name,
                           const KLocalizedString &task = KLocalizedString(),
                           const QByteArray &emailAddress = QByteArray(),
                           const QByteArray &webAddress = QByteArray());

    KDELIBS4SUPPORT_DEPRECATED explicit K4AboutPerson(const KLocalizedString &name,
                           const KLocalizedString &task,
                           const QByteArray &emailAddress,
                           const QByteArray &webAddress,
                           const QByteArray &ocsUsername);  //KDE5: merge into main ctor

    K4AboutPerson(const K4AboutPerson &other);

    ~K4AboutPerson();

    K4AboutPerson &operator=(const K4AboutPerson &other);

    QString name() const;

    QString task() const;

    QString emailAddress() const;

    QString webAddress() const;

    QString ocsUsername() const;

private:
    KDELIBS4SUPPORT_DEPRECATED explicit K4AboutPerson(const QString &name, const QString &email);

    class Private;
    Private *const d;
};

class K4AboutLicense;

// KDE5: refactor together with KComponentData.
// Like changing all property names which contain Program or App.

class KDELIBS4SUPPORT_DEPRECATED_EXPORT_NOISE K4AboutData
{
public:
    enum LicenseKey { // KDE5: move to K4AboutLicense, cut License_ prefix
        License_Custom = -2,
        License_File = -1,
        License_Unknown = 0,
        License_GPL  = 1,
        License_GPL_V2 = 1,
        License_LGPL = 2,
        License_LGPL_V2 = 2,
        License_BSD  = 3,
        License_Artistic = 4,
        License_QPL = 5,
        License_QPL_V1_0 = 5,
        License_GPL_V3 = 6,
        License_LGPL_V3 = 7
    };

    enum NameFormat { // KDE5: move to K4AboutLicense
        ShortName,
        FullName
    };

public:
    K4AboutData(const QByteArray &appName,
                const QByteArray &catalogName,
                const KLocalizedString &programName,
                const QByteArray &version,
                const KLocalizedString &shortDescription = KLocalizedString(),
                enum LicenseKey licenseType = License_Unknown,
                const KLocalizedString &copyrightStatement = KLocalizedString(),
                const KLocalizedString &otherText = KLocalizedString(),
                const QByteArray &homePageAddress = QByteArray(),
                const QByteArray &bugsEmailAddress = "[email protected]"
               );

    K4AboutData(const K4AboutData &other);

    K4AboutData &operator=(const K4AboutData &other);

    ~K4AboutData();

    operator KAboutData() const;

    K4AboutData &addAuthor(const KLocalizedString &name,
                           const KLocalizedString &task = KLocalizedString(),
                           const QByteArray &emailAddress = QByteArray(),
                           const QByteArray &webAddress = QByteArray());

    K4AboutData &addAuthor(const KLocalizedString &name,
                           const KLocalizedString &task,
                           const QByteArray &emailAddress,
                           const QByteArray &webAddress,
                           const QByteArray &ocsUsername);  //KDE5: merge with addAuthor

    K4AboutData &addCredit(const KLocalizedString &name,
                           const KLocalizedString &task = KLocalizedString(),
                           const QByteArray &emailAddress = QByteArray(),
                           const QByteArray &webAddress = QByteArray());

    K4AboutData &addCredit(const KLocalizedString &name,
                           const KLocalizedString &task,
                           const QByteArray &emailAddress,
                           const QByteArray &webAddress,
                           const QByteArray &ocsUsername);  //KDE5: merge with addCredit

    K4AboutData &setTranslator(const KLocalizedString &name,
                               const KLocalizedString &emailAddress);

    K4AboutData &setLicenseText(const KLocalizedString &license);

    K4AboutData &addLicenseText(const KLocalizedString &license);

    K4AboutData &setLicenseTextFile(const QString &file);

    K4AboutData &addLicenseTextFile(const QString &file);

    K4AboutData &setAppName(const QByteArray &appName);

    K4AboutData &setProgramName(const KLocalizedString &programName);

    K4AboutData &setProgramIconName(const QString &iconName);

    K4AboutData &setProgramLogo(const QVariant &image);

    K4AboutData &setOcsProvider(const QByteArray &providerUrl);

    K4AboutData &setVersion(const QByteArray &version);

    K4AboutData &setShortDescription(const KLocalizedString &shortDescription);

    K4AboutData &setCatalogName(const QByteArray &catalogName);

    K4AboutData &setLicense(LicenseKey licenseKey);

    K4AboutData &addLicense(LicenseKey licenseKey);

    K4AboutData &setCopyrightStatement(const KLocalizedString &copyrightStatement);

    K4AboutData &setOtherText(const KLocalizedString &otherText);

    K4AboutData &setHomepage(const QByteArray &homepage);

    K4AboutData &setBugAddress(const QByteArray &bugAddress);

    K4AboutData &setOrganizationDomain(const QByteArray &domain);

    K4AboutData &setProductName(const QByteArray &name);

    QString appName() const;

    QString productName() const;

    QString programName() const;

    QString organizationDomain() const;

    const char *internalProgramName() const;

    void translateInternalProgramName() const;

    QString programIconName() const;

    QVariant programLogo() const;

    QString ocsProviderUrl() const;

    QString version() const;

    const char *internalVersion() const;

    QString shortDescription() const;

    QString catalogName() const;

    QString homepage() const;

    QString bugAddress() const;

    const char *internalBugAddress() const;

    QList<K4AboutPerson> authors() const;

    QList<K4AboutPerson> credits() const;

    QList<K4AboutPerson> translators() const;

    static QString aboutTranslationTeam();

    QString otherText() const;

    QString license() const;

    QString licenseName(NameFormat formatName) const;

    QList<K4AboutLicense> licenses() const;

    QString copyrightStatement() const;

    QString customAuthorPlainText() const;

    QString customAuthorRichText() const;

    bool customAuthorTextEnabled() const;

    K4AboutData &setCustomAuthorText(const KLocalizedString &plainText,
                                     const KLocalizedString &richText);

    K4AboutData &unsetCustomAuthorText();

private:

    class Private;
    Private *const d;
};

class KDELIBS4SUPPORT_DEPRECATED_EXPORT_NOISE K4AboutLicense
{
    friend class K4AboutData;
public:
    K4AboutLicense(const K4AboutLicense &other);

    ~K4AboutLicense();

    K4AboutLicense &operator=(const K4AboutLicense &other);

    QString text() const;

    QString name(K4AboutData::NameFormat formatName) const;

    K4AboutData::LicenseKey key() const;

    static K4AboutLicense byKeyword(const QString &keyword);

private:
    KDELIBS4SUPPORT_DEPRECATED explicit K4AboutLicense(enum K4AboutData::LicenseKey licenseType, const K4AboutData *aboutData);
    KDELIBS4SUPPORT_DEPRECATED explicit K4AboutLicense(const QString &pathToFile, const K4AboutData *aboutData);
    KDELIBS4SUPPORT_DEPRECATED explicit K4AboutLicense(const KLocalizedString &licenseText, const K4AboutData *aboutData);

    class Private;
    QSharedDataPointer<Private> d;
};

#endif