kprogress.h

/* This file is part of the KDE libraries
   Copyright (C) 1996 Martynas Kunigelis
 
   This library is free software; you can redistribute it and/or
   modify it under the terms of the GNU Library General Public
   License version 2 as published by the Free Software Foundation.
 
   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.
*/
/*****************************************************************************
*                                                                            *
*  KProgress -- progress indicator widget for KDE                            *
*  Original QRangeControl-based version written by Martynas Kunigelis        *
*  Current TQProgressBar based version by Aaron Seigo                         *
*                                                                            *
*****************************************************************************/
 
#ifndef _KPROGRESS_H
#define _KPROGRESS_H "$Id$"
 
#include <tqprogressbar.h>
#include <kdialogbase.h>

class TDEUI_EXPORT KProgress : public TQProgressBar
{
  TQ_OBJECT
 
public:
  KProgress(TQWidget *parent=0, const char *name=0, WFlags f = 0);

  KProgress(int totalSteps, TQWidget *parent=0, const char *name=0, WFlags f = 0);

  ~KProgress();

  void setTextEnabled(bool);

  // ### Remove this KDE 4.0
  int value() const TDE_DEPRECATED;

  bool textEnabled() const;

  TQString format() const;

  // ### Remove this KDE 4.0
  void setRange(int min, int max) TDE_DEPRECATED;

  // ### Remove this KDE 4.0
  int maxValue() TDE_DEPRECATED;
 
public slots:

  void setFormat(const TQString & format);

  void setTotalSteps(int totalSteps);

  virtual void setProgress(int progress);

  // ### Remove this KDE 4.0
  void setValue(int progress);

  virtual void advance(int offset);
 
signals:
  void percentageChanged(int);
 
protected:
  virtual bool setIndicator(TQString & indicator, int progress, int totalSteps);
 
private:
  TQString   mFormat;
 
protected:
  virtual void virtual_hook( int id, void* data );
private:
  class KProgressPrivate;
  KProgressPrivate *d;
};

class TDEUI_EXPORT KProgressDialog : public KDialogBase
{
    TQ_OBJECT
 
    public:
        KProgressDialog(TQWidget* parent = 0, const char* name = 0,
                        const TQString& caption = TQString::null,
                        const TQString& text = TQString::null,
                        bool modal = false);

        ~KProgressDialog();

        KProgress* progressBar();

        const KProgress* progressBar() const;

        void    setLabel(const TQString & text);

        // ### Remove this KDE 4.0
        TQString labelText() TDE_DEPRECATED;

        TQString labelText() const;

        void setAllowCancel(bool allowCancel);

        // ### Remove this KDE 4.0
        bool allowCancel() TDE_DEPRECATED;

        bool allowCancel() const;

        void showCancelButton(bool show);

        void setAutoClose(bool close);

        // ### Remove this KDE 4.0
        bool autoClose();

        bool autoClose() const;

        void setAutoReset(bool autoReset);

        // ### Remove this KDE 4.0
        bool autoReset();

        bool autoReset() const;

        // ### Remove this KDE 4.0
        bool wasCancelled();

        bool wasCancelled() const;

        void ignoreCancel();

        void setButtonText(const TQString&);

        // ### Remove this KDE 4.0
        TQString buttonText() TDE_DEPRECATED;

        TQString buttonText() const;

        void setMinimumDuration(int ms);

        // ### Remove this KDE 4.0
        int  minimumDuration() TDE_DEPRECATED;

        int  minimumDuration() const;

        virtual void show();
 
    protected slots:
        void slotAutoShow();
        void slotAutoActions(int percentage);
        void slotCancel();
 
    private:
        // ### Move these member variables to d in KDE 4.0
        bool       mAutoClose;
        bool       mAutoReset;
        bool       mCancelled;
        bool       mAllowCancel;
        bool       mShown;
        TQString    mCancelText;
        TQLabel*    mLabel;
        KProgress* mProgressBar;
        TQTimer*    mShowTimer;
        int        mMinDuration;
    protected:
    virtual void virtual_hook( int id, void* data );
    private:
        struct KProgressDialogPrivate;
        KProgressDialogPrivate *d;
};
 
#endif