kprogressbox.h

/* This file is part of the KDE libraries
   Copyright (C) 2010 Timothy Pearson
   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.
*/
/*****************************************************************************
*                                                                            *
*  KProgressBox -- progress indicator widget for KDE                         *
*  Original QRangeControl-based version written by Martynas Kunigelis        *
*  Current TQProgressBar based version by Aaron Seigo                         *
*  Textbox extension by Timothy Pearson                                      * 
*                                                                            *
*****************************************************************************/
 
#ifndef _KProgressBox_H
#define _KProgressBox_H "$Id: KProgressBox.h 589356 2006-09-28 00:58:09Z tpearson $"
 
#include <tqprogressbar.h>
#include <kdialogbase.h>
#include <kprogress.h>
#include <ktextedit.h>

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

        ~KProgressBoxDialog();

        KProgress* progressBar();

        KTextEdit* textEdit();

        const KProgress* progressBar() const;

        const KTextEdit* textEdit() const;

        void    setLabel(const TQString & text);

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

        TQString labelText() const;

        void setAllowCancel(bool allowCancel);

        void setAllowTextEdit(bool allowTextEdit);

        // ### 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       mAllowTextEdit;
        bool       mShown;
        TQString    mCancelText;
        TQLabel*    mLabel;
        KProgress* mProgressBar;
        KTextEdit* mTextBox;
        TQTimer*    mShowTimer;
        int        mMinDuration;
    protected:
    virtual void virtual_hook( int id, void* data );
    private:
        struct KProgressBoxDialogPrivate;
        KProgressBoxDialogPrivate *d;
};
 
#endif