File indexing completed on 2024-04-21 14:55:58

 /* This file is part of the KDE libraries
    Copyright (C) 1996 Martynas Kunigelis // krazy:exclude=copyright (email unknown)
    Copyright (C) 2006-2007 Urs Wolfer <uwolfer at 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 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.
 */
 
 #ifndef KPROGRESSDIALOG_H
 #define KPROGRESSDIALOG_H
 
 #include <QProgressBar>
 
 #include <kdialog.h>
 #include <kdelibs4support_export.h>
 
 /**
  * @short A dialog with a progress bar
  *
  * KProgressDialog 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 KProgressDialog.
  * 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 QProgressBar is available through direct access
  * to the progress bar widget via progressBar();
  *
  * \image html kprogressdialog.png "KDE Progress Dialog"
  *
  * @author Aaron J. Seigo
  * @author Urs Wolfer uwolfer @ kde.org
  *
  * @deprecated since 5.0, use QProgressDialog instead
  */
 class KDELIBS4SUPPORT_DEPRECATED_EXPORT KProgressDialog : public KDialog
 {
     Q_OBJECT
 
 public:
     /**
      * Constructs a KProgressDialog
      *
      * @param parent Parent of the widget
      * @param caption Text to display in window title bar
      * @param text Text to display in the dialog
      * @param flags The widget flags
      */
     KDELIBS4SUPPORT_DEPRECATED explicit KProgressDialog(QWidget *parent = nullptr, const QString &caption = QString(),
                              const QString &text = QString(), Qt::WindowFlags flags = {});
 
     /**
      * Destructor
      */
     ~KProgressDialog() override;
 
     /**
      * Returns the QProgressBar used in this dialog.
      * To set the number of steps or other progress bar related
      * settings, access the QProgressBar object directly via this method.
      */
     QProgressBar *progressBar();
 
     /**
      * Returns the QProgressBar used in this dialog.
      * To set the number of steps or other progress bar related
      * settings, access the QProgressBar object directly via this method.
      */
     const QProgressBar *progressBar() const;
 
     /**
      * Sets the text in the dialog
      *
      * @param text the text to display
      */
     void setLabelText(const QString &text);
 
     /**
      * 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.
      *
      * The default is true.
      *
      * @param allowCancel Set to true to make the dialog non-closable
      */
     void setAllowCancel(bool allowCancel);
 
     /**
      * 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)
      *
      * The default is true.
      *
      * @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 QProgressBar have been completed.
      *
      * The default is true.
      */
     void setAutoClose(bool close);
 
     /**
      * Returns true if the dialog will close upon completion,
      * or false otherwise
      */
     bool autoClose() const;
 
     /**
      * Sets whether the dialog should reset the QProgressBar dialog
      * back to 0 steps compelete when all steps have been completed.
      * This is useful for KProgressDialogs that will be reused.
      *
      * The default is false.
      */
     void setAutoReset(bool autoReset);
 
     /**
      * Returns true if the QProgressBar 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.
      */
     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?"
      */
     void ignoreCancel();
 
     /**
      * Sets the text to appear on the cancel button.
      */
     void setButtonText(const QString &text);
 
     /**
      * Returns the text on the cancel button
      */
     QString buttonText() const;
 
     /**
      * Set the minimum number of milliseconds to wait before
      * actually showing the dialog.
      *
      * If the expected duration of the task is less than the minimumDuration, the dialog will
      * not appear at all. This prevents the dialog popping up for tasks that are quickly over.
      * For tasks that are expected to exceed the minimumDuration, the dialog will pop up after
      * the minimumDuration time.
      * If set to 0, the dialog is always shown immediately. The default is
      * 2000 milliseconds.
      */
     void setMinimumDuration(int ms);
 
     /**
      * Returns the time that must pass before the dialog appears.
      * @see setMinimumDuration
      */
     int minimumDuration() const;
 
     void reject() override;
 
 protected:
     void showEvent(QShowEvent *event) override;
 
 private:
     Q_PRIVATE_SLOT(d, void slotAutoShow())
     Q_PRIVATE_SLOT(d, void slotAutoActions(int percentage))
 
 private:
     class KProgressDialogPrivate;
     friend class KProgressDialogPrivate;
     KProgressDialogPrivate *const d;
 
     Q_DISABLE_COPY(KProgressDialog)
 };
 
 #endif