aboutdata.h

Go to the documentation of this file.

#ifndef ABOUTDATA_H
#define ABOUTDATA_H

#include <QString>
#include <QSharedDataPointer>

template <class T> class QList;
class QVariant;
class AboutData;

class AboutPerson
{
    friend class AboutData;
    public:
        explicit AboutPerson(const QString &name, const QString &task = QString(), const QByteArray &emailAddress = QByteArray(), const QByteArray &webAddress = QByteArray());

        AboutPerson(const AboutPerson& other);
        ~AboutPerson();
        AboutPerson& operator=(const AboutPerson& other);
        QString name() const;
        QString task() const;
        QString emailAddress() const;
        QString webAddress() const;

    private:

        explicit AboutPerson(QString & name, QString & email);

        class Private;
        Private *const d;
};

class AboutLicense;

class AboutData
{
    public:
        enum NameFormat
        {
            ShortName,
            FullName
        };

        AboutData(const QByteArray &appName, const QByteArray &catalogName, const QString &programName, const QByteArray &version, const QString &shortDescription = QString(), const QString &copyrightStatement = QString(), const QString &text = QString(), const QByteArray &homePageAddress = QByteArray(), const QByteArray &bugsEmailAddress = "allevo.bugs@gmx.at");
        AboutData(const AboutData& other);
        AboutData& operator=(const AboutData& other);
        ~AboutData();
        AboutData &addAuthor(const QString &name, const QString &task = QString(), const QByteArray &emailAddress = QByteArray(), const QByteArray &webAddress = QByteArray());
        AboutData &addCredit(const QString &name, const QString &task = QString(), const QByteArray &emailAddress = QByteArray(), const QByteArray &webAddress = QByteArray());
        AboutData &setTranslator(const QString& name, const QString& emailAddress);
        AboutData &setAppName(const QByteArray &appName);
        AboutData &setProgramName(const QString &programName);
        AboutData &setProgramIconName(const QString &iconName);
        AboutData &setProgramLogo(const QVariant& image);
        AboutData &setVersion(const QByteArray &version);
        AboutData &setShortDescription(const QString &shortDescription);
        AboutData &setCatalogName(const QByteArray &catalogName);
        AboutData &setCopyrightStatement(const QString &copyrightStatement);
        AboutData &setOtherText(const QString &otherText);
        AboutData &setHomepage(const QByteArray &homepage);
        AboutData &setBugAddress(const QByteArray &bugAddress);
        AboutData &setOrganizationDomain(const QByteArray &domain);
        AboutData &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 version() const;
        const char* internalVersion() const;
        QString shortDescription() const;
        QString catalogName() const;
        QString homepage() const;
        QString bugAddress() const;
        const char* internalBugAddress() const;
        QList<AboutPerson> authors() const;
        QList<AboutPerson> credits() const;
        QList<AboutPerson> translators() const;
        static QString aboutTranslationTeam();
        QString otherText() const;
        QString license() const;
        QString licenseName(NameFormat formatName) const;
        QString copyrightStatement() const;
        QString customAuthorPlainText() const;
        QString customAuthorRichText() const;
        bool customAuthorTextEnabled() const;
        AboutData &setCustomAuthorText(const QString &plainText, const QString &richText);
        AboutData &unsetCustomAuthorText();

    private:
        class Private;
        Private *const d;
};

#endif

---