Added new kprogressbox dialog

git-svn-id: svn://anonsvn.kde.org/home/kde/branches/trinity/kdelibs@1104966 283d02a7-25f6-0310-bc7c-ecb5cbfe19da

3 files changed, 609 insertions, 2 deletions

diff --git a/kdeui/Makefile.am b/kdeui/Makefile.am
index 761c1db63..4d60c273b 100644
--- a/kdeui/Makefile.am
+++ b/kdeui/Makefile.am
@@ -36,7 +36,7 @@ libkspell_la_SOURCES = dummy.cpp
 picsdir = $(kde_datadir)/kdeui/pics
 pics_DATA = aboutkde.png ktip-bulb.png ktip-background.png
 
-include_HEADERS = kprogress.h kcolordlg.h \
+include_HEADERS = kprogressbox.h kprogress.h kcolordlg.h \
 		kcolordialog.h kselect.h \
 		kdatepik.h kdatepicker.h kdatetbl.h kfontdialog.h kpopupmenu.h \
 		kfontrequester.h ktabctl.h kstatusbar.h \
@@ -86,7 +86,7 @@ libkdeui_la_SOURCES = \
 		kactioncollection.cpp kactionclasses.cpp \
 		kurllabel.cpp kmenubar.cpp kinputdialog.cpp \
 		knuminput.cpp klineedit.cpp klistview.cpp kprogress.cpp \
-		kcolordialog.cpp kselect.cpp kdatepicker.cpp \
+		kprogressbox.cpp kcolordialog.cpp kselect.cpp kdatepicker.cpp \
 		kdatetbl.cpp kfontrequester.cpp kfontdialog.cpp ktabctl.cpp \
 		kstatusbar.cpp kmainwindow.cpp \
 		keditlistbox.cpp kscrollview.cpp \
diff --git a/kdeui/kprogressbox.cpp b/kdeui/kprogressbox.cpp
new file mode 100644
index 000000000..965d8179b
--- /dev/null
+++ b/kdeui/kprogressbox.cpp
@@ -0,0 +1,316 @@
+/* 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 -- a progress indicator widget for KDE with an expandable textbox provided below the progress bar.
+ */
+
+#include <stdlib.h>
+#include <limits.h>
+
+#include <qpainter.h>
+#include <qpixmap.h>
+#include <qlabel.h>
+#include <qlayout.h>
+#include <qpushbutton.h>
+#include <qstring.h>
+#include <qregexp.h>
+#include <qstyle.h>
+#include <qtimer.h>
+
+#include "kprogress.h"
+#include "ktextedit.h"
+#include "kprogressbox.h"
+
+#include <kapplication.h>
+#include <klocale.h>
+#include <kwin.h>
+
+struct KProgressBoxDialog::KProgressBoxDialogPrivate
+{
+    KProgressBoxDialogPrivate() : cancelButtonShown(true)
+    {
+    }
+
+    bool cancelButtonShown;
+};
+
+/*
+ * KProgressBoxDialog implementation
+ */
+KProgressBoxDialog::KProgressBoxDialog(QWidget* parent, const char* name,
+                                 const QString& caption, const QString& text,
+                                 bool modal)
+    : KDialogBase(KDialogBase::Plain, caption, KDialogBase::Cancel,
+                  KDialogBase::Cancel, parent, name, modal),
+      mAutoClose(true),
+      mAutoReset(false),
+      mCancelled(false),
+      mAllowCancel(true),
+      mAllowTextEdit(false),
+      mShown(false),
+      mMinDuration(2000),
+      d(new KProgressBoxDialogPrivate)
+{
+#ifdef Q_WS_X11
+    KWin::setIcons(winId(), kapp->icon(), kapp->miniIcon());
+#endif
+    mShowTimer = new QTimer(this);
+    
+    showButton(KDialogBase::Close, false);
+    mCancelText = actionButton(KDialogBase::Cancel)->text();
+
+    QFrame* mainWidget = plainPage();
+    QVBoxLayout* layout = new QVBoxLayout(mainWidget, 10);
+
+    mLabel = new QLabel(text, mainWidget);
+    layout->addWidget(mLabel);
+
+    mProgressBar = new KProgress(mainWidget);
+    layout->addWidget(mProgressBar);
+    mTextBox = new KTextEdit(mainWidget);
+    layout->addWidget(mTextBox);
+
+    connect(mProgressBar, SIGNAL(percentageChanged(int)),
+            this, SLOT(slotAutoActions(int)));
+    connect(mShowTimer, SIGNAL(timeout()), this, SLOT(slotAutoShow()));
+    mShowTimer->start(mMinDuration, true);
+}
+
+KProgressBoxDialog::~KProgressBoxDialog()
+{
+    delete d;
+}
+
+void KProgressBoxDialog::slotAutoShow()
+{
+    if (mShown || mCancelled)
+    {
+        return;
+    }
+
+    show();
+    kapp->processEvents();
+}
+
+void KProgressBoxDialog::slotCancel()
+{
+    mCancelled = true;
+
+    if (mAllowCancel)
+    {
+        KDialogBase::slotCancel();
+    }
+}
+
+bool KProgressBoxDialog::wasCancelled()
+{
+    return mCancelled;
+}
+
+void KProgressBoxDialog::ignoreCancel()
+{
+    mCancelled = false;
+}
+
+bool KProgressBoxDialog::wasCancelled() const
+{
+    return mCancelled;
+}
+
+void KProgressBoxDialog::setMinimumDuration(int ms)
+{
+    mMinDuration = ms;
+    if (!mShown)
+    {
+        mShowTimer->stop();
+        mShowTimer->start(mMinDuration, true);
+    }
+}
+
+int KProgressBoxDialog::minimumDuration()
+{
+    return mMinDuration;
+}
+
+int KProgressBoxDialog::minimumDuration() const
+{
+    return mMinDuration;
+}
+
+void KProgressBoxDialog::setAllowCancel(bool allowCancel)
+{
+    mAllowCancel = allowCancel;
+    showCancelButton(allowCancel);
+}
+
+void KProgressBoxDialog::setAllowTextEdit(bool allowTextEdit)
+{
+    mAllowTextEdit = allowTextEdit;
+    mTextBox->setReadOnly(!allowTextEdit);
+}
+
+// ### KDE 4 remove
+bool KProgressBoxDialog::allowCancel()
+{
+    return mAllowCancel;
+}
+
+bool KProgressBoxDialog::allowCancel() const
+{
+    return mAllowCancel;
+}
+
+KProgress* KProgressBoxDialog::progressBar()
+{
+    return mProgressBar;
+}
+
+KTextEdit* KProgressBoxDialog::textEdit()
+{
+    return mTextBox;
+}
+
+const KProgress* KProgressBoxDialog::progressBar() const
+{
+    return mProgressBar;
+}
+
+const KTextEdit* KProgressBoxDialog::textEdit() const
+{
+    return mTextBox;
+}
+
+void KProgressBoxDialog::setLabel(const QString& text)
+{
+    mLabel->setText(text);
+}
+
+// ### KDE 4 remove
+QString KProgressBoxDialog::labelText()
+{
+    return mLabel->text();
+}
+
+QString KProgressBoxDialog::labelText() const
+{
+    return mLabel->text();
+}
+
+void KProgressBoxDialog::showCancelButton(bool show)
+{
+    showButtonCancel(show);
+}
+
+// ### KDE 4 remove
+bool KProgressBoxDialog::autoClose()
+{
+    return mAutoClose;
+}
+
+bool KProgressBoxDialog::autoClose() const
+{
+    return mAutoClose;
+}
+
+void KProgressBoxDialog::setAutoClose(bool autoClose)
+{
+    mAutoClose = autoClose;
+}
+
+// ### KDE 4 remove
+bool KProgressBoxDialog::autoReset()
+{
+    return mAutoReset;
+}
+
+bool KProgressBoxDialog::autoReset() const
+{
+    return mAutoReset;
+}
+
+void KProgressBoxDialog::setAutoReset(bool autoReset)
+{
+    mAutoReset = autoReset;
+}
+
+void KProgressBoxDialog::setButtonText(const QString& text)
+{
+    mCancelText = text;
+    setButtonCancel(text);
+}
+
+// ### KDE 4 remove
+QString KProgressBoxDialog::buttonText()
+{
+    return mCancelText;
+}
+
+QString KProgressBoxDialog::buttonText() const
+{
+    return mCancelText;
+}
+
+void KProgressBoxDialog::slotAutoActions(int percentage)
+{
+    if (percentage < 100)
+    {
+        if (!d->cancelButtonShown)
+        {
+            setButtonCancel(mCancelText);
+            d->cancelButtonShown = true;
+        }
+        return;
+    }
+
+    mShowTimer->stop();
+
+    if (mAutoReset)
+    {
+        mProgressBar->setProgress(0);
+    }
+    else
+    {
+        setAllowCancel(true);
+        setButtonCancel(KStdGuiItem::close());
+        d->cancelButtonShown = false;
+    }
+
+    if (mAutoClose)
+    {
+        if (mShown)
+        {
+            hide();
+        }
+        else
+        {
+            emit finished();
+        }
+    }
+}
+
+void KProgressBoxDialog::show()
+{
+    KDialogBase::show();
+    mShown = true;
+}
+
+void KProgressBoxDialog::virtual_hook( int id, void* data )
+{ KDialogBase::virtual_hook( id, data ); }
+
+#include "kprogressbox.moc"
diff --git a/kdeui/kprogressbox.h b/kdeui/kprogressbox.h
new file mode 100644
index 000000000..25fbee4dc
--- /dev/null
+++ b/kdeui/kprogressbox.h
@@ -0,0 +1,291 @@
+/* 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 QProgressBar 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 <qprogressbar.h>
+#include <kdialogbase.h>
+#include <kprogress.h>
+#include <ktextedit.h>
+
+/**
+ * KProgressBoxDialog provides a dialog with a text label, a progress bar
+ * and an optional cancel button with a KDE look 'n feel.
+ *
+ * Since knowing how long it can take to complete an action and it is
+ * undesirable to show a dialog for a split second before hiding it,
+ * there are a few ways to control the timing behavior of KProgressBoxDialog.
+ * There is a time out that can be set before showing the dialog as well
+ * as an option to autohide or keep displaying the dialog once complete.
+ *
+ * All the functionality of KProgressBox is available through direct access
+ * to the progress bar widget via progressBar();
+ *
+ * Also, an expandable textbox provided below the progress bar.
+ *
+ * @short A dialog with a progress bar and text box.
+ * @author Timothy Pearson
+ */
+class KDEUI_EXPORT KProgressBoxDialog : public KDialogBase
+{
+    Q_OBJECT
+
+    public:
+        /**
+         * Constructs a KProgressBoxDialog
+         *
+         * @param parent Parent of the widget
+         * @param name Widget name
+         * @param caption Text to display in window title bar
+         * @param text Text to display in the dialog
+         * @param modal Set to true to make the dialog modal
+         */
+        KProgressBoxDialog(QWidget* parent = 0, const char* name = 0,
+                        const QString& caption = QString::null,
+                        const QString& text = QString::null,
+                        bool modal = false);
+
+        /**
+         * Destructor
+         */
+        ~KProgressBoxDialog();
+
+        /**
+         * Returns the KProgressBox used in this dialog.
+         * To set the number of steps or other progress bar related
+         * settings, access the KProgressBox object directly via this method.
+         */
+        KProgress* progressBar();
+
+        /**
+         * Returns the KTextEdit used in this dialog.
+         * To set the number of lines or other text box related
+         * settings, access the KTextEdit object directly via this method.
+         */
+        KTextEdit* textEdit();
+
+        /**
+         * Returns the KProgressBox used in this dialog.
+         * To set the number of steps or other progress bar related
+         * settings, access the KProgressBox object directly via this method.
+         */
+        const KProgress* progressBar() const;
+
+        /**
+         * Returns the KTextEdit used in this dialog.
+         * To set the number of lines or other text box related
+         * settings, access the KTextEdit object directly via this method.
+         */
+        const KTextEdit* textEdit() const;
+
+        /**
+         * Sets the text in the dialog
+         *
+         * @param text the text to display
+         */
+        void    setLabel(const QString & text);
+
+        /**
+         * Returns the current dialog text
+         * @deprecated
+         */
+        // ### Remove this KDE 4.0
+        QString labelText() KDE_DEPRECATED;
+
+        /**
+         * Returns the current dialog text
+         */
+        QString labelText() const;
+
+        /**
+         * Sets whether or not the user can cancel the process.
+         * If the dialog is cancellable, the Cancel button will be shown
+         * and the user can close the window using the window decorations.
+         * If the process is not (or should not be) interuptable,
+         * set the dialog to be modal and not cancellable.
+         *
+         * @param allowCancel Set to true to make the dialog non-closable
+         */
+        void setAllowCancel(bool allowCancel);
+
+        /**
+         * Sets whether or not the user can edit the text shown in the textbox.
+         *
+         * @param allowTextEdit Set to true to make the text editable
+         */
+        void setAllowTextEdit(bool allowTextEdit);
+
+        /**
+         * Returns true if the dialog can be canceled, false otherwise
+         * @deprecated
+         */
+        // ### Remove this KDE 4.0
+        bool allowCancel() KDE_DEPRECATED;
+
+        /**
+         * Returns true if the dialog can be canceled, false otherwise
+         */
+        bool allowCancel() const;
+
+        /**
+         * Sets whether the cancel button is visible. setAllowCancel(false)
+         * implies showCancelButton(false)
+         *
+         * @param show Whether or not the cancel button should be shown
+         */
+        void showCancelButton(bool show);
+
+        /**
+         * Sets whether the dialog should close automagically when
+         * all the steps in the KProgressBox have been completed.
+         */
+        void setAutoClose(bool close);
+
+        /**
+         * Returns true if the dialog will close upon completion,
+         * or false otherwise
+         */
+        // ### Remove this KDE 4.0
+        bool autoClose();
+
+        /**
+         * Returns true if the dialog will close upon completion,
+         * or false otherwise
+         */
+        bool autoClose() const;
+
+        /**
+         * Sets whether the dialog should reset the KProgressBox dialog
+         * back to 0 steps compelete when all steps have been completed.
+         * This is useful for KProgressBoxDialogs that will be reused.
+         */
+        void setAutoReset(bool autoReset);
+
+        /**
+         * Returns true if the KProgressBox widget will be reset
+         * upon completion, or false otherwise
+         */
+        // ### Remove this KDE 4.0
+        bool autoReset();
+
+        /**
+         * Returns true if the KProgressBox widget will be reset
+         * upon completion, or false otherwise
+         */
+        bool autoReset() const;
+
+        /**
+         * Returns true if the dialog was closed or canceled
+         * before completion. If the dialog is not cancellable
+         * it will always return false.
+         */
+        // ### Remove this KDE 4.0
+        bool wasCancelled();
+
+        /**
+         * Returns true if the dialog was closed or canceled
+         * before completion. If the dialog is not cancellable
+         * it will always return false.
+         */
+        bool wasCancelled() const;
+
+        /**
+         * Ignores the last cancel action if the cancel button was 
+         * pressed. Useful for kdialog when combined with a KMessageBox
+         * to display a message like "Are you sure you want to cancel?" 
+	 * @since 3.5.5
+         */
+        void ignoreCancel();
+
+        /**
+         * Sets the text to appear on the cancel button.
+         */
+        void setButtonText(const QString&);
+
+        /**
+         * Returns the text on the cancel button
+         * @deprecated
+         */
+        // ### Remove this KDE 4.0
+        QString buttonText() KDE_DEPRECATED;
+
+        /**
+         * Returns the text on the cancel button
+         */
+        QString buttonText() const;
+
+        /**
+         * Set the minimum number of milliseconds to wait before
+         * actually showing the dialog
+         */
+        void setMinimumDuration(int ms);
+
+        /**
+         * Returns the wait duration in milliseconds
+         * @deprecated
+         */
+        // ### Remove this KDE 4.0
+        int  minimumDuration() KDE_DEPRECATED;
+
+        /**
+         * Returns the wait duration in milliseconds
+         */
+        int  minimumDuration() const;
+
+ 	/**
+	 * Reimplemented for internal reasons, the API is not affected.
+	 */
+        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;
+        QString    mCancelText;
+        QLabel*    mLabel;
+        KProgress* mProgressBar;
+        KTextEdit* mTextBox;
+        QTimer*    mShowTimer;
+        int        mMinDuration;
+    protected:
+	virtual void virtual_hook( int id, void* data );
+    private:
+        struct KProgressBoxDialogPrivate;
+        KProgressBoxDialogPrivate *d;
+};
+
+#endif