tdeaboutdialog.h

/*
 * 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 _TDEABOUTDIALOG_H_
#define _TDEABOUTDIALOG_H_
 
#include <kdialogbase.h>
#include <tqstring.h>
 
class TQFrame;
class TQLabel;
class TQVBoxLayout;
class TQTabWidget;
class KURLLabel;
class TDEAboutContainer;
class TDEAboutContainerBase;
 
class TDEAboutWidgetPrivate;
 
class TDEAboutContainerPrivate;
class TDEUI_EXPORT TDEAboutContainer : public TQFrame
{
  TQ_OBJECT
 
  public:
    TDEAboutContainer( TQWidget *parent=0, const char *name=0,
             int margin=0, int spacing=0,
             int childAlignment = AlignCenter,
             int innerAlignment = AlignCenter );
 
    void addWidget( TQWidget *widget );
    void addPerson( const TQString &name, const TQString &email,
            const TQString &url, const TQString &task,
            bool showHeader = false, bool showframe = false,
            bool showBold = false );
    void addTitle(  const TQString &title, int alignment=AlignLeft,
            bool showframe = false, bool showBold = false );
    void addImage( const TQString &fileName, int alignment=AlignLeft );
 
    virtual TQSize sizeHint( void ) const;
    virtual TQSize minimumSizeHint( void ) const;
 
  protected:
    virtual void childEvent( TQChildEvent *e );
 
  signals:
    void urlClick( const TQString &url );
    void mailClick( const TQString &name, const TQString &address );
 
 
  private:
    TQVBoxLayout *mVbox;
    int mAlignment;
    TDEAboutContainerPrivate* const d;
};
 
class TDEAboutContributorPrivate;
 
class TDEUI_EXPORT TDEAboutContributor : public TQFrame
{
  TQ_OBJECT
 
  public:
    TDEAboutContributor( TQWidget *parent=0, const char *name=0,
               const TQString &username=TQString::null,
               const TQString &email=TQString::null,
               const TQString &url=TQString::null,
               const TQString &work=TQString::null,
               bool showHeader=false, bool showFrame=true,
               bool showBold=false );
 
    void setName( const TQString &text, const TQString &header=TQString::null,
          bool update = true );
    void setEmail( const TQString &text, const TQString &header=TQString::null,
           bool update = true );
    void setURL( const TQString &text, const TQString &header=TQString::null,
         bool update = true );
    void setWork( const TQString &text, const TQString &header=TQString::null,
          bool update = true );
    TQString getName( void ) const;
    TQString getEmail( void ) const;
    TQString getURL( void ) const;
    TQString getWork( void ) const;
 
    virtual TQSize sizeHint( void ) const;
 
  protected:
    virtual void fontChange( const TQFont &oldFont );
 
  protected slots:
    void urlClickedSlot( const TQString& );
    void emailClickedSlot( const TQString& emailaddress );
 
  private:
    void updateLayout( void );
 
  signals:
    void sendEmail(const TQString& name, const TQString& email);
    void openURL(const TQString& url);
 
  private:
    TQLabel *mLabel[4];
    TQLabel *mText[4];
    bool mShowHeader;
    bool mShowBold;
 
    TDEAboutContributorPrivate* const d;
 
    virtual void setName(const char *_name) { TQFrame::setName(_name); }
};
 
class TDEUI_EXPORT TDEAboutWidget : public TQWidget
{
  TQ_OBJECT
 
public:
 
  TDEAboutWidget(TQWidget* parent=0, const char* name=0 );
 
  void adjust();
 
  void setLogo(const TQPixmap&);
  void setAuthor(const TQString& name, const TQString& email,
         const TQString& url, const TQString& work);
  void setMaintainer(const TQString& name, const TQString& email,
             const TQString& url, const TQString& work);
  void addContributor(const TQString& name, const TQString& email,
              const TQString& url, const TQString& work);
  void setVersion(const TQString& name);
  // -------------------------------------------------------------------------
protected slots:
  void sendEmailSlot(const TQString& name, const TQString& email);
  void openURLSlot(const TQString& url);
  // -------------------------------------------------------------------------
signals:
  void sendEmail(const TQString& name, const TQString& email);
  void openURL(const TQString& url);
  // -------------------------------------------------------------------------
protected:
  // events:
  void resizeEvent(TQResizeEvent*);
  TQLabel *version;
  TQLabel *cont;
  TQLabel *logo;
  TDEAboutContributor *author;
  TDEAboutContributor *maintainer;
  bool showMaintainer;
  TQPtrList<TDEAboutContributor> contributors;
  // #########################################################################
  //
private:
  TDEAboutWidgetPrivate* const d;
};
 
class TDEAboutDialogPrivate;
class TDEUI_EXPORT TDEAboutDialog : public KDialogBase
{
  TQ_OBJECT
 
  public:
    enum LayoutType
    {
      AbtPlain         = 0x0001,
      AbtTabbed        = 0x0002,
      AbtTitle         = 0x0004,
      AbtImageLeft     = 0x0008,
      AbtImageRight    = 0x0010,
      AbtImageOnly     = 0x0020,
      AbtProduct       = 0x0040,
      AbtKDEStandard   = AbtTabbed|AbtTitle|AbtImageLeft,
      AbtAppStandard   = AbtTabbed|AbtTitle|AbtProduct,
      AbtImageAndTitle = AbtPlain|AbtTitle|AbtImageOnly
    };
 
  public:
    TDEAboutDialog( TQWidget *parent=0, const char *name=0, bool modal=true );
 
    TDEAboutDialog( int dialogLayout, const TQString &caption, int buttonMask,
          ButtonCode defaultButton, TQWidget *parent=0,
          const char *name=0, bool modal=false, bool separator = false,
          const TQString &user1 = TQString::null,
          const TQString &user2 = TQString::null,
          const TQString &user3 = TQString::null );
 
  void adjust();
 
  virtual void show( void );
 
  virtual void show( TQWidget *centerParent );
 
  void setTitle( const TQString &title );
 
  void setImage( const TQString &fileName );
 
  void setIcon( const TQString &fileName ) TDE_DEPRECATED; // KDE4: remove
 
  void setProgramLogo( const TQString &fileName );
 
  void setProgramLogo( const TQPixmap &pixmap );
 
  void setImageBackgroundColor( const TQColor &color );
 
  void setImageFrame( bool state );
 
  void setProduct( const TQString &appName, const TQString &version,
           const TQString &author, const TQString &year );
 
  TQFrame *addTextPage( const TQString &title, const TQString &text,
                       bool richText=false, int numLines=10 );
 
  TQFrame *addLicensePage( const TQString &title, const TQString &text,
                          int numLines=10 );
 
  TDEAboutContainer *addContainerPage( const TQString &title,
    int childAlignment = AlignCenter, int innerAlignment = AlignCenter );
 
  TDEAboutContainer *addScrolledContainerPage( const TQString &title,
    int childAlignment = AlignCenter, int innerAlignment = AlignCenter );
 
  TDEAboutContainer *addContainer( int childAlignment, int innerAlignment );
 
  TQFrame *addPage( const TQString &title );
 
 
  void setLogo(const TQPixmap&);
 
  void setAuthor(const TQString& name, const TQString& email,
         const TQString& url, const TQString& work);
 
  void setMaintainer(const TQString& name, const TQString& email,
             const TQString& url, const TQString& work);
 
  void addContributor(const TQString& name, const TQString& email,
              const TQString& url, const TQString& work);
 
  void setVersion(const TQString& name);
 
  static void imageURL( TQWidget *parent, const TQString &caption,
              const TQString &path, const TQColor &imageColor,
              const TQString &url );
 
signals:
  void sendEmail(const TQString& name, const TQString& email);
 
  void openURL(const TQString& url);
  // ----------------------------------------------------------------------------
protected:
  TDEAboutWidget * about;
 
  TDEAboutContainerBase *mContainerBase;
 
  // -------------------------------------------------------------------------
protected slots:
 
  void sendEmailSlot(const TQString& name, const TQString& email);
 
  void openURLSlot(const TQString& url);
 
  virtual void mouseTrackSlot( int mode, const TQMouseEvent *e );
 
  // #########################################################################
protected:
  virtual void virtual_hook( int id, void* data );
private:
  TDEAboutDialogPrivate* const d;
};
 
#endif // defined TDEABOUTDIALOG_H