k3aboutdialog.h

Go to the documentation of this file.

/*
 * This file is part of the KDE Libraries
 * Copyright (C) 1999-2001 Mirko Boehm (mirko@kde.org) and
 * 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.
 *
 */

/*
 * This file declares a class for creating "About ..." dialogs
 * in a general way. It provides geometry management and some
 * options to connect for, like emailing the author or maintainer.
 */


#ifndef K3ABOUTDIALOG_H
#define K3ABOUTDIALOG_H

#include <kde3support_export.h>

#include <QtGui/QFrame>
#include <kdialog.h>

class QLabel;
class QLabel;
class K3AboutContainer;
class K3AboutContainerBase;

class KDE3SUPPORT_EXPORT K3AboutContainer : public QFrame
{
  Q_OBJECT

  public:
    K3AboutContainer( QWidget *parent = 0,
                     int margin = 0, int spacing = 0,
                     Qt::Alignment childAlignment = Qt::AlignCenter,
                     Qt::Alignment innerAlignment = Qt::AlignCenter );

    ~K3AboutContainer();

    void addWidget( QWidget *widget );

    void addPerson( const QString &name, const QString &email,
                    const QString &url, const QString &task,
                    bool showHeader = false, bool showframe = false,
                    bool showBold = false );

    void addTitle( const QString &title, Qt::Alignment alignment = Qt::AlignLeft,
                   bool showframe = false, bool showBold = false );

    void addImage( const QString &fileName, Qt::Alignment alignment = Qt::AlignLeft );

    virtual QSize sizeHint() const;
    virtual QSize minimumSizeHint() const;

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

class KDE3SUPPORT_EXPORT K3AboutContributor : public QFrame
{
  Q_OBJECT

  public:
    K3AboutContributor( QWidget *parent = 0,
                       const QString &username = QString(),
                       const QString &email = QString(),
                       const QString &url = QString(),
                       const QString &work = QString(),
                       bool showHeader = false, bool showFrame = true,
                       bool showBold = false );

    ~K3AboutContributor();

    void setName( const QString &text, const QString &header = QString(),
                  bool update = true );

    void setEmail( const QString &text, const QString &header = QString(),
                   bool update = true );

    void setUrl( const QString &text, const QString &header = QString(),
                 bool update = true );

    void setWork( const QString &text, const QString &header = QString(),
                  bool update = true );

    QString name() const;
    QString email() const;
    QString url() const;
    QString work() const;

    virtual QSize sizeHint() const;

  protected:
    virtual void fontChange( const QFont &oldFont );

  private:
    class Private;
    Private* const d;

    virtual void setName(const char *_name) { QObject::setObjectName(QLatin1String(_name)); }
};

class KDE3SUPPORT_EXPORT K3AboutWidget : public QWidget
{
  Q_OBJECT

  public:

    K3AboutWidget( QWidget* parent=0 );

    void adjust();

    void setLogo( const QPixmap &logo );

    void setAuthor( const QString& name, const QString& email,
                    const QString& url, const QString& work );

    void setMaintainer( const QString& name, const QString& email,
                        const QString& url, const QString& work );

    void addContributor( const QString& name, const QString& email,
                         const QString& url, const QString& work );

    void setVersion( const QString& name );

  protected:
    void resizeEvent(QResizeEvent*);

    QLabel *version;

    QLabel *cont;

    QLabel *logo;

    K3AboutContributor *author;

    K3AboutContributor *maintainer;

    bool showMaintainer;

    QList<K3AboutContributor *> contributors;

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

class KDE3SUPPORT_EXPORT K3AboutDialog : public KDialog
{
  Q_OBJECT

  public:

    enum LayoutType
    {
      Plain         = 0x0001,
      Tabbed        = 0x0002,
      Title         = 0x0004,
      ImageLeft     = 0x0008,
      ImageRight    = 0x0010,
      ImageOnly     = 0x0020,
      Product       = 0x0040,
      KDEStandard   = Tabbed | Title | ImageLeft,
      AppStandard   = Tabbed | Title | Product,
      ImageAndTitle = Plain | Title | ImageOnly
    };

  public:
    K3AboutDialog( QWidget *parent=0 );

    K3AboutDialog( int dialogLayout, const QString &caption, QWidget *parent=0 );

    void adjust();

    virtual void show();

    virtual void show( QWidget *centerParent );

    void setTitle( const QString &title );

    void setImage( const QString &fileName );

    void setProgramLogo( const QString &fileName );

    void setProgramLogo( const QPixmap &pixmap );

    void setImageBackgroundColor( const QColor &color );

    void setImageFrame( bool state );

    void setProduct( const QString &appName, const QString &version,
                     const QString &author, const QString &year );

    QFrame *addTextPage( const QString &title, const QString &text,
                         bool richText=false, int numLines=10 );

    QFrame *addLicensePage( const QString &title, const QString &text,
                            int numLines=10 );

    K3AboutContainer *addContainerPage( const QString &title,
                                       Qt::Alignment childAlignment = Qt::AlignCenter,
                                       Qt::Alignment innerAlignment = Qt::AlignCenter );

    K3AboutContainer *addScrolledContainerPage( const QString &title,
                                               Qt::Alignment childAlignment = Qt::AlignCenter,
                                               Qt::Alignment innerAlignment = Qt::AlignCenter );

    K3AboutContainer *addContainer( Qt::Alignment childAlignment, Qt::Alignment innerAlignment );

    QFrame *addPage( const QString &title );

    void setLogo( const QPixmap &logo );

    void setAuthor( const QString& name, const QString& email,
                    const QString& url, const QString& work );

    void setMaintainer( const QString& name, const QString& email,
                        const QString& url, const QString& work );

    void addContributor( const QString& name, const QString& email,
                         const QString& url, const QString& work );

    void setVersion( const QString& name );

    static void imageUrl( QWidget *parent, const QString &caption,
                          const QString &path, const QColor &imageColor,
                          const QString &url );

  protected:
    K3AboutWidget *mAbout;

    K3AboutContainerBase *mContainerBase;

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

#endif // defined K3ABOUTDIALOG_H