kdialogbase.h

/*
 *  This file is part of the KDE Libraries
 *  Copyright (C) 1999-2001 Mirko Boehm (mirko@kde.org) and
 *  Espen Sand (espen@kde.org)
 *  Holger Freyther <freyther@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.
 *
 */
#ifndef _KDIALOG_BASE_H_
#define _KDIALOG_BASE_H_
 
#include <kdialog.h>
#include <kjanuswidget.h>
#include <kguiitem.h>
#include <kstdguiitem.h>
#include <tqptrlist.h>
 
class TQPushButton;
class KSeparator;
class KURLLabel;
class TQBoxLayout;
class TQPixmap;
class KGuiItem;
class KDialogBaseButton;

class KDialogBaseTile;

class TDEUI_EXPORT KDialogBase : public KDialog
{
  TQ_OBJECT
 
  public:
 
    enum ButtonCode
    {
      Help    = 0x00000001, 
      Default = 0x00000002, 
      Ok      = 0x00000004, 
      Apply   = 0x00000008, 
      Try     = 0x00000010, 
      Cancel  = 0x00000020, 
      Close   = 0x00000040, 
      User1   = 0x00000080, 
      User2   = 0x00000100, 
      User3   = 0x00000200, 
      No      = 0x00000080, 
      Yes     = 0x00000100, 
      Details = 0x00000400, 
      Filler  = 0x40000000, 
      Stretch = 0x80000000, 
      NoDefault             
    };
 
    enum ActionButtonStyle
    {
      ActionStyle0=0, // KDE std
      ActionStyle1,
      ActionStyle2,
      ActionStyle3,
      ActionStyle4,
      ActionStyleMAX
    };

    enum DialogType
    {
      TreeList  = KJanusWidget::TreeList,
      Tabbed    = KJanusWidget::Tabbed,
      Plain     = KJanusWidget::Plain,
      Swallow   = KJanusWidget::Swallow,
      IconList  = KJanusWidget::IconList
    };
 
  public:

    KDialogBase( TQWidget *parent=0, const char *name=0, bool modal=true,
         const TQString &caption=TQString::null,
         int buttonMask=Ok|Apply|Cancel, ButtonCode defaultButton=Ok,
         bool separator=false,
         const KGuiItem &user1=KGuiItem(),
         const KGuiItem &user2=KGuiItem(),
         const KGuiItem &user3=KGuiItem() );

    KDialogBase( int dialogFace, const TQString &caption,
         int buttonMask, ButtonCode defaultButton,
         TQWidget *parent=0, const char *name=0, bool modal=true,
         bool separator=false,
         const KGuiItem &user1=KGuiItem(),
         const KGuiItem &user2=KGuiItem(),
         const KGuiItem &user3=KGuiItem() );
 

 
    KDialogBase( KDialogBase::DialogType dialogFace, WFlags f,
         TQWidget *parent=0, const char *name=0, bool modal=true,
         const TQString &caption=TQString::null,
         int buttonMask=Ok|Apply|Cancel, ButtonCode defaultButton=Ok,
         bool separator=false,
         const KGuiItem &user1=KGuiItem(),
         const KGuiItem &user2=KGuiItem(),
         const KGuiItem &user3=KGuiItem() );

    KDialogBase( const TQString &caption, int buttonMask=Yes|No|Cancel,
         ButtonCode defaultButton=Yes, ButtonCode escapeButton=Cancel,
         TQWidget *parent=0, const char *name=0,
         bool modal=true, bool separator=false,
         const KGuiItem &yes = KStdGuiItem::yes(), // i18n("&Yes")
         const KGuiItem &no = KStdGuiItem::no(), // i18n("&No"),
         const KGuiItem &cancel = KStdGuiItem::cancel() // i18n("&Cancel")
         );

    ~KDialogBase();

    void setButtonBoxOrientation( int orientation );

    void setEscapeButton( ButtonCode id );
 

    virtual void adjustSize();
    virtual TQSize sizeHint() const;
    virtual TQSize minimumSizeHint() const;

    TQFrame *plainPage();

    TQFrame  *addPage( const TQString &itemName,
              const TQString &header=TQString::null,
              const TQPixmap &pixmap=TQPixmap() );

    TQFrame  *addPage( const TQStringList &items,
              const TQString &header=TQString::null,
              const TQPixmap &pixmap=TQPixmap() );

    TQVBox *addVBoxPage( const TQString &itemName,
            const TQString &header=TQString::null,
            const TQPixmap &pixmap=TQPixmap() );

    TQVBox *addVBoxPage( const TQStringList &items,
            const TQString &header=TQString::null,
            const TQPixmap &pixmap=TQPixmap() );

    TQHBox *addHBoxPage( const TQString &itemName,
            const TQString &header=TQString::null,
            const TQPixmap &pixmap=TQPixmap() );

    TQHBox *addHBoxPage( const TQStringList &items,
            const TQString &header=TQString::null,
            const TQPixmap &pixmap=TQPixmap() );

    TQGrid *addGridPage( int n, Orientation dir,
            const TQString &itemName,
            const TQString &header=TQString::null,
            const TQPixmap &pixmap=TQPixmap() );
 

    TQGrid *addGridPage( int n, Orientation dir,
            const TQStringList &items,
            const TQString &header=TQString::null,
            const TQPixmap &pixmap=TQPixmap() );
 

    void setFolderIcon(const TQStringList &path,const TQPixmap &pixmap);

    TQFrame *makeMainWidget();

    TQVBox *makeVBoxMainWidget();

    TQHBox *makeHBoxMainWidget();

    TQGrid *makeGridMainWidget( int n, Orientation dir );
 

    void enableButtonSeparator( bool state );

    void showButton( ButtonCode id, bool state );

    void showButtonOK( bool state );

    void showButtonApply( bool state );

    void showButtonCancel( bool state );

    bool showPage( int index );

    int activePageIndex() const;
 

    int pageIndex( TQWidget *widget ) const;
 

    void setMainWidget( TQWidget *widget );

    TQWidget *mainWidget();

    void disableResize();

    void setInitialSize( const TQSize &s, bool noResize=false );

    void incInitialSize( const TQSize &s, bool noResize=false );

   TQSize configDialogSize( const TQString& groupName ) const;

   TQSize configDialogSize( TDEConfig& config, const TQString& groupName ) const;

   void saveDialogSize( const TQString& groupName, bool global=false );

   void saveDialogSize( TDEConfig& config, const TQString& groupName,
                 bool global=false ) const;

    void setButtonOK( const KGuiItem &item = KStdGuiItem::ok() );

    void setButtonOKText( const TQString &text=TQString::null,
              const TQString &tooltip=TQString::null,
              const TQString &quickhelp=TQString::null ) TDE_DEPRECATED;

    void setButtonApply( const KGuiItem &item = KStdGuiItem::apply() );

    void setButtonApplyText( const TQString &text=TQString::null,
                 const TQString &tooltip=TQString::null,
                 const TQString &quickhelp=TQString::null ) TDE_DEPRECATED;

    void setButtonCancel( const KGuiItem &item = KStdGuiItem::cancel() );

    void setButtonCancelText( const TQString &text=TQString::null,
                  const TQString &tooltip=TQString::null,
                  const TQString &quickhelp=TQString::null ) TDE_DEPRECATED;

    void setButtonText( ButtonCode id, const TQString &text );

    void setButtonTip( ButtonCode id, const TQString &text );

    void setButtonWhatsThis( ButtonCode id, const TQString &text );

    void setButtonGuiItem( ButtonCode id, const KGuiItem &item );

     void setTreeListAutoResize( bool state );

    void setShowIconsInTreeList(bool state);

    void setRootIsDecorated( bool state );

    void unfoldTreeList( bool persist = false );

    void addWidgetBelowList( TQWidget * widget );

    void addButtonBelowList( const TQString & text, TQObject * recv, const char * slot );

    void addButtonBelowList( const KGuiItem & guiitem, TQObject * recv, const char * slot );

    void setIconListAllVisible( bool state );

    static bool haveBackgroundTile();

    static const TQPixmap *backgroundTile();
    static const TQPixmap *getBackgroundTile() TDE_DEPRECATED;

    static void setBackgroundTile( const TQPixmap *pix );

    void showTile( bool state );

    void  getBorderWidths( int& ulx, int& uly, int& lrx, int& lry ) const TDE_DEPRECATED;

    TQRect getContentsRect() const TDE_DEPRECATED;

    TQSize calculateSize( int w, int h ) const;

    TQString helpLinkText() const;

    TQPushButton *actionButton( ButtonCode id );
 
  public slots:
    void enableButton( ButtonCode id, bool state );

    void enableButtonOK( bool state );

    void enableButtonApply( bool state );

    void enableButtonCancel( bool state );

    void enableLinkedHelp( bool state );

    void delayedDestruct();

    void setHelpLinkText( const TQString &text );

    void setHelp( const TQString &anchor,
          const TQString &appname = TQString::null );

    void helpClickedSlot( const TQString & );

    void setDetails(bool showDetails);

    void setDetailsWidget(TQWidget *detailsWidget);

    void updateBackground();

    void cancel();
 
  signals:
    void helpClicked();

    void defaultClicked();
 

    void user3Clicked();

    void user2Clicked();

    void user1Clicked();

    void applyClicked();

    void tryClicked();

    void okClicked();

    void yesClicked();

    void noClicked();

    void cancelClicked();

    void closeClicked();

    void apply();

    void backgroundChanged();

    void hidden();

    void finished();

    void aboutToShowDetails();

    void aboutToShowPage(TQWidget *page);
 
  protected:
    virtual void keyPressEvent( TQKeyEvent *e );

    virtual void hideEvent( TQHideEvent * );

    virtual void closeEvent( TQCloseEvent *e );
 
  protected slots:
    virtual void slotHelp();

    virtual void slotDefault();

    virtual void slotDetails();

    virtual void slotUser3();

    virtual void slotUser2();

    virtual void slotUser1();

    virtual void slotOk();

    virtual void slotApply();

    virtual void slotTry();

    virtual void slotYes();

    virtual void slotNo();

    virtual void slotCancel();

    virtual void slotClose();

    virtual void applyPressed();

    void updateGeometry();

    void slotDelayedDestruct();
 
  private:
    void setupLayout();

    void makeRelay();

    void makeButtonBox( int mask, ButtonCode defaultButton,
            const KGuiItem &user1 = KGuiItem(),
            const KGuiItem &user2 = KGuiItem(),
            const KGuiItem &user3 = KGuiItem() );

    void setButtonFocus( TQPushButton *p, bool isDefault, bool isFocus );

    void printMakeMainWidgetError();
 
  private slots:
    void setButtonStyle( int style );
 
 
  private:
    TQBoxLayout   *mTopLayout;
    TQWidget      *mMainWidget;
    KURLLabel    *mUrlHelp;
    KJanusWidget *mJanus;
    KSeparator   *mActionSep;
 
    bool mIsActivated;
 
    TQString mAnchor;
    TQString mHelpApp;
    TQString mHelpLinkText;
 
    static KDialogBaseTile *mTile;
    bool   mShowTile;
 
    bool mMessageBoxMode;
    int  mButtonOrientation;
    ButtonCode mEscapeButton;
 
  protected:
    virtual void virtual_hook( int id, void* data );
  private:
    class KDialogBasePrivate;
    KDialogBasePrivate* const d;
};
 
#endif