tdeaboutdata.h

/*
 * This file is part of the KDE Libraries
 * Copyright (C) 2000 Espen Sand (espen@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.
 *
 */
 
#include <tqvaluelist.h>
#include <tqstring.h>
#include <tqimage.h>
#include <tdelocale.h>
 
#ifndef _TDEABOUTDATA_H_
#define _TDEABOUTDATA_H_
 
class TDEAboutPersonPrivate;
class TDEAboutDataPrivate;
 
class TDECORE_EXPORT TDEAboutPerson
{
public:
    TDEAboutPerson( const char *name, const char *task,
                  const char *emailAddress, const char *webAddress )
    {
      mName = name;
      mTask = task;
      mEmailAddress = emailAddress;
      mWebAddress = webAddress;
    }
    TDEAboutPerson() {}
 
    TQString name() const;
 
    TQString task() const;
 
    TQString emailAddress() const;
 
    TQString webAddress() const;
 
private:
    const char *mName;
    const char *mTask;
    const char *mEmailAddress;
    const char *mWebAddress;
 
    TDEAboutPersonPrivate *d;
};
 
class TDEAboutTranslatorPrivate;
class TDECORE_EXPORT TDEAboutTranslator
{
public:
    TDEAboutTranslator(const TQString & name=TQString::null,
                     const TQString & emailAddress=TQString::null);
 
    TQString name() const;
 
    TQString emailAddress() const;
 
private:
    TQString mName;
    TQString mEmail;
    TDEAboutTranslatorPrivate* d;
};
 
 
class TDECORE_EXPORT TDEAboutData
{
  public:
    enum LicenseKey
    {
      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,
      License_MIT = 8
    };
 
  public:
    TDEAboutData( const char *appName,
                const char *programName,
        const char *version,
        const char *shortDescription = 0,
        int licenseType = License_Unknown,
        const char *copyrightStatement = 0,
        const char *text = 0,
        const char *homePageAddress = 0,
        const char *bugsEmailAddress = 0
        );
 
     ~TDEAboutData();
 
    void addAuthor( const char *name,
            const char *task=0,
            const char *emailAddress=0,
            const char *webAddress=0 );
 
    void addCredit( const char *name,
                    const char *task=0,
            const char *emailAddress=0,
            const char *webAddress=0 );
 
    void setTranslator(const char* name, const char* emailAddress);
 
    void setLicenseText( const char *license );
 
    void setLicenseTextFile( const TQString &file );
 
    void setAppName( const char *appName );
    
    void setProgramName( const char* programName );
 
    void setProgramLogo(const TQImage& image);
 
    void setVersion( const char* version );
    
    void setShortDescription( const char *shortDescription );
    
    void setLicense( LicenseKey licenseKey);
    
    void setCopyrightStatement( const char *copyrightStatement );
    
    void setOtherText( const char *otherText );
    
    void setHomepage( const char *homepage );
    
    void setBugAddress( const char *bugAddress );
    
    void setProductName( const char *name );
 
    const char *appName() const;
 
    const char *productName() const;
 
    TQString programName() const;
 
    const char* internalProgramName() const;
    void translateInternalProgramName() const;
 
    TQImage programLogo() const;
 
    TQString version() const;
 
    const char* internalVersion() const { return mVersion; }
 
    TQString shortDescription() const;
 
    TQString homepage() const;
 
    TQString bugAddress() const;
    
    const char* internalBugAddress() const { return mBugEmailAddress; }
 
    const TQValueList<TDEAboutPerson> authors() const;
 
    const TQValueList<TDEAboutPerson> credits() const;
 
    const TQValueList<TDEAboutTranslator> translators() const;
 
    static TQString aboutTranslationTeam();
 
    TQString otherText() const;
 
    TQString license() const;
 
    TQString copyrightStatement() const;
 
    TQString customAuthorPlainText() const;
 
    TQString customAuthorRichText() const;
 
    bool customAuthorTextEnabled() const;
    
    void setCustomAuthorText(const TQString &plainText, const TQString &richText);
    
    void unsetCustomAuthorText();
    
  private:
    const char *mAppName;
    const char *mProgramName;
    const char *mVersion;
    const char *mShortDescription;
    int mLicenseKey;
    const char *mCopyrightStatement;
    const char *mOtherText;
    const char *mHomepageAddress;
    const char *mBugEmailAddress;
    TQValueList<TDEAboutPerson> mAuthorList;
    TQValueList<TDEAboutPerson> mCreditList;
    const char *mLicenseText;
    static const char *defaultBugTracker;
 
    TDEAboutDataPrivate *d;
};
 
#endif