Search for usage in LXR

#include <kprogressdialog.h>

Inheritance diagram for KProgressDialog:

Public Member Functions

 KProgressDialog (QWidget *parent=nullptr, const QString &caption=QString(), const QString &text=QString(), Qt::WindowFlags flags={})
 ~KProgressDialog () override
bool allowCancel () const
bool autoClose () const
bool autoReset () const
QString buttonText () const
void ignoreCancel ()
QString labelText () const
int minimumDuration () const
QProgressBarprogressBar ()
const QProgressBarprogressBar () const
void reject () override
void setAllowCancel (bool allowCancel)
void setAutoClose (bool close)
void setAutoReset (bool autoReset)
void setButtonText (const QString &text)
void setLabelText (const QString &text)
void setMinimumDuration (int ms)
void showCancelButton (bool show)
bool wasCancelled () const
- Public Member Functions inherited from KDialog
 KDialog (QWidget *parent=nullptr, Qt::WindowFlags flags={})
 ~KDialog () override
QPushButtonbutton (ButtonCode id) const
QIcon buttonIcon (ButtonCode id) const
QString buttonText (ButtonCode id) const
QString buttonToolTip (ButtonCode id) const
QString buttonWhatsThis (ButtonCode id) const
ButtonCode defaultButton () const
QString helpLinkText () const
void incrementInitialSize (const QSize &size)
bool isButtonEnabled (ButtonCode id) const
QWidgetmainWidget ()
QSize minimumSizeHint () const override
void restoreDialogSize (const KConfigGroup &config)
void saveDialogSize (KConfigGroup &config, KConfigGroup::WriteConfigFlags options=KConfigGroup::Normal) const
void setButtonFocus (ButtonCode id)
void setButtonGuiItem (ButtonCode id, const KGuiItem &item)
void setButtonIcon (ButtonCode id, const QIcon &icon)
void setButtonMenu (ButtonCode id, QMenu *menu, ButtonPopupMode popupmode=InstantPopup)
void setButtons (ButtonCodes buttonMask)
void setButtonsOrientation (Qt::Orientation orientation)
void setButtonText (ButtonCode id, const QString &text)
void setButtonToolTip (ButtonCode id, const QString &text)
void setButtonWhatsThis (ButtonCode id, const QString &text)
void setDefaultButton (ButtonCode id)
void setEscapeButton (ButtonCode id)
void setInitialSize (const QSize &size)
void setMainWidget (QWidget *widget)
void showButton (ButtonCode id, bool state)
void showButtonSeparator (bool state)
QSize sizeHint () const override
- Public Member Functions inherited from QDialog
 QDialog (QWidget *parent, Qt::WindowFlags f)
virtual void accept ()
void accepted ()
virtual void done (int r)
virtual int exec ()
QWidgetextension () const const
void finished (int result)
bool isSizeGripEnabled () const const
virtual void open ()
Qt::Orientation orientation () const const
void rejected ()
int result () const const
void setExtension (QWidget *extension)
void setModal (bool modal)
void setOrientation (Qt::Orientation orientation)
void setResult (int i)
void setSizeGripEnabled (bool)
virtual void setVisible (bool visible) override
void showExtension (bool showIt)
- Public Member Functions inherited from QWidget
 QWidget (QWidget *parent, Qt::WindowFlags f)
bool acceptDrops () const const
QString accessibleDescription () const const
QString accessibleName () const const
QList< QAction * > actions () const const
void activateWindow ()
void addAction (QAction *action)
void addActions (QList< QAction * > actions)
void adjustSize ()
bool autoFillBackground () const const
QPalette::ColorRole backgroundRole () const const
QBackingStorebackingStore () const const
QSize baseSize () const const
QWidgetchildAt (const QPoint &p) const const
QWidgetchildAt (int x, int y) const const
QRect childrenRect () const const
QRegion childrenRegion () const const
void clearFocus ()
void clearMask ()
bool close ()
QMargins contentsMargins () const const
QRect contentsRect () const const
Qt::ContextMenuPolicy contextMenuPolicy () const const
QCursor cursor () const const
void customContextMenuRequested (const QPoint &pos)
WId effectiveWinId () const const
void ensurePolished () const const
Qt::FocusPolicy focusPolicy () const const
QWidgetfocusProxy () const const
QWidgetfocusWidget () const const
const QFontfont () const const
QFontInfo fontInfo () const const
QFontMetrics fontMetrics () const const
QPalette::ColorRole foregroundRole () const const
QRect frameGeometry () const const
QSize frameSize () const const
const QRectgeometry () const const
void getContentsMargins (int *left, int *top, int *right, int *bottom) const const
QPixmap grab (const QRect &rectangle)
void grabGesture (Qt::GestureType gesture, Qt::GestureFlags flags)
void grabKeyboard ()
void grabMouse ()
void grabMouse (const QCursor &cursor)
int grabShortcut (const QKeySequence &key, Qt::ShortcutContext context)
QGraphicsEffectgraphicsEffect () const const
QGraphicsProxyWidgetgraphicsProxyWidget () const const
bool hasEditFocus () const const
bool hasFocus () const const
virtual bool hasHeightForWidth () const const
bool hasMouseTracking () const const
bool hasTabletTracking () const const
int height () const const
virtual int heightForWidth (int w) const const
void hide ()
Qt::InputMethodHints inputMethodHints () const const
virtual QVariant inputMethodQuery (Qt::InputMethodQuery query) const const
void insertAction (QAction *before, QAction *action)
void insertActions (QAction *before, QList< QAction * > actions)
bool isActiveWindow () const const
bool isAncestorOf (const QWidget *child) const const
bool isEnabled () const const
bool isEnabledTo (const QWidget *ancestor) const const
bool isEnabledToTLW () const const
bool isFullScreen () const const
bool isHidden () const const
bool isMaximized () const const
bool isMinimized () const const
bool isModal () const const
bool isTopLevel () const const
bool isVisible () const const
bool isVisibleTo (const QWidget *ancestor) const const
bool isWindow () const const
bool isWindowModified () const const
QLayoutlayout () const const
Qt::LayoutDirection layoutDirection () const const
QLocale locale () const const
void lower ()
QPoint mapFrom (const QWidget *parent, const QPoint &pos) const const
QPoint mapFromGlobal (const QPoint &pos) const const
QPoint mapFromParent (const QPoint &pos) const const
QPoint mapTo (const QWidget *parent, const QPoint &pos) const const
QPoint mapToGlobal (const QPoint &pos) const const
QPoint mapToParent (const QPoint &pos) const const
QRegion mask () const const
int maximumHeight () const const
QSize maximumSize () const const
int maximumWidth () const const
int minimumHeight () const const
QSize minimumSize () const const
int minimumWidth () const const
void move (const QPoint &)
void move (int x, int y)
QWidgetnativeParentWidget () const const
QWidgetnextInFocusChain () const const
QRect normalGeometry () const const
void overrideWindowFlags (Qt::WindowFlags flags)
virtual QPaintEnginepaintEngine () const const override
const QPalettepalette () const const
QWidgetparentWidget () const const
QPoint pos () const const
QWidgetpreviousInFocusChain () const const
void raise ()
QRect rect () const const
void releaseKeyboard ()
void releaseMouse ()
void releaseShortcut (int id)
void removeAction (QAction *action)
void render (QPaintDevice *target, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void render (QPainter *painter, const QPoint &targetOffset, const QRegion &sourceRegion, QWidget::RenderFlags renderFlags)
void repaint ()
void repaint (const QRect &rect)
void repaint (const QRegion &rgn)
void repaint (int x, int y, int w, int h)
void resize (const QSize &)
void resize (int w, int h)
bool restoreGeometry (const QByteArray &geometry)
QByteArray saveGeometry () const const
QScreenscreen () const const
void scroll (int dx, int dy)
void scroll (int dx, int dy, const QRect &r)
void setAcceptDrops (bool on)
void setAccessibleDescription (const QString &description)
void setAccessibleName (const QString &name)
void setAttribute (Qt::WidgetAttribute attribute, bool on)
void setAutoFillBackground (bool enabled)
void setBackgroundRole (QPalette::ColorRole role)
void setBaseSize (const QSize &)
void setBaseSize (int basew, int baseh)
void setContentsMargins (const QMargins &margins)
void setContentsMargins (int left, int top, int right, int bottom)
void setContextMenuPolicy (Qt::ContextMenuPolicy policy)
void setCursor (const QCursor &)
void setDisabled (bool disable)
void setEditFocus (bool enable)
void setEnabled (bool)
void setFixedHeight (int h)
void setFixedSize (const QSize &s)
void setFixedSize (int w, int h)
void setFixedWidth (int w)
void setFocus ()
void setFocus (Qt::FocusReason reason)
void setFocusPolicy (Qt::FocusPolicy policy)
void setFocusProxy (QWidget *w)
void setFont (const QFont &)
void setForegroundRole (QPalette::ColorRole role)
void setGeometry (const QRect &)
void setGeometry (int x, int y, int w, int h)
void setGraphicsEffect (QGraphicsEffect *effect)
void setHidden (bool hidden)
void setInputMethodHints (Qt::InputMethodHints hints)
void setLayout (QLayout *layout)
void setLayoutDirection (Qt::LayoutDirection direction)
void setLocale (const QLocale &locale)
void setMask (const QBitmap &bitmap)
void setMask (const QRegion &region)
void setMaximumHeight (int maxh)
void setMaximumSize (const QSize &)
void setMaximumSize (int maxw, int maxh)
void setMaximumWidth (int maxw)
void setMinimumHeight (int minh)
void setMinimumSize (const QSize &)
void setMinimumSize (int minw, int minh)
void setMinimumWidth (int minw)
void setMouseTracking (bool enable)
void setPalette (const QPalette &)
void setParent (QWidget *parent)
void setParent (QWidget *parent, Qt::WindowFlags f)
void setShortcutAutoRepeat (int id, bool enable)
void setShortcutEnabled (int id, bool enable)
void setSizeIncrement (const QSize &)
void setSizeIncrement (int w, int h)
void setSizePolicy (QSizePolicy)
void setSizePolicy (QSizePolicy::Policy horizontal, QSizePolicy::Policy vertical)
void setStatusTip (const QString &)
void setStyle (QStyle *style)
void setStyleSheet (const QString &styleSheet)
void setTabletTracking (bool enable)
void setToolTip (const QString &)
void setToolTipDuration (int msec)
void setUpdatesEnabled (bool enable)
void setupUi (QWidget *widget)
void setWhatsThis (const QString &)
void setWindowFilePath (const QString &filePath)
void setWindowFlag (Qt::WindowType flag, bool on)
void setWindowFlags (Qt::WindowFlags type)
void setWindowIcon (const QIcon &icon)
void setWindowIconText (const QString &)
void setWindowModality (Qt::WindowModality windowModality)
void setWindowModified (bool)
void setWindowOpacity (qreal level)
void setWindowRole (const QString &role)
void setWindowState (Qt::WindowStates windowState)
void setWindowTitle (const QString &)
void show ()
void showFullScreen ()
void showMaximized ()
void showMinimized ()
void showNormal ()
QSize size () const const
QSize sizeIncrement () const const
QSizePolicy sizePolicy () const const
void stackUnder (QWidget *w)
QString statusTip () const const
QStylestyle () const const
QString styleSheet () const const
bool testAttribute (Qt::WidgetAttribute attribute) const const
QString toolTip () const const
int toolTipDuration () const const
QWidgettopLevelWidget () const const
bool underMouse () const const
void ungrabGesture (Qt::GestureType gesture)
void unsetCursor ()
void unsetLayoutDirection ()
void unsetLocale ()
void update ()
void update (const QRect &rect)
void update (const QRegion &rgn)
void update (int x, int y, int w, int h)
void updateGeometry ()
bool updatesEnabled () const const
QRegion visibleRegion () const const
QString whatsThis () const const
int width () const const
QWidgetwindow () const const
QString windowFilePath () const const
Qt::WindowFlags windowFlags () const const
QWindowwindowHandle () const const
QIcon windowIcon () const const
void windowIconChanged (const QIcon &icon)
QString windowIconText () const const
void windowIconTextChanged (const QString &iconText)
Qt::WindowModality windowModality () const const
qreal windowOpacity () const const
QString windowRole () const const
Qt::WindowStates windowState () const const
QString windowTitle () const const
void windowTitleChanged (const QString &title)
Qt::WindowType windowType () const const
WId winId () const const
int x () const const
int y () const const
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
bool blockSignals (bool block)
const QObjectListchildren () const const
QMetaObject::Connection connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void deleteLater ()
void destroyed (QObject *obj)
bool disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool disconnect (const QObject *receiver, const char *method) const const
void dumpObjectInfo ()
void dumpObjectInfo () const const
void dumpObjectTree ()
void dumpObjectTree () const const
QList< QByteArraydynamicPropertyNames () const const
findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegExp &regExp, Qt::FindChildOptions options) const const
QList< T > findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T > findChildren (const QString &name, Qt::FindChildOptions options) const const
bool inherits (const char *className) const const
void installEventFilter (QObject *filterObj)
bool isWidgetType () const const
bool isWindowType () const const
void killTimer (int id)
virtual const QMetaObjectmetaObject () const const
void moveToThread (QThread *targetThread)
QString objectName () const const
void objectNameChanged (const QString &objectName)
QObjectparent () const const
QVariant property (const char *name) const const
 Q_CLASSINFO (Name, Value)
 Q_ENUM (...)
 Q_ENUM_NS (...)
 Q_ENUMS (...)
 Q_FLAG (...)
 Q_FLAG_NS (...)
 Q_FLAGS (...)
qFindChild (const QObject *obj, const QString &name)
QList< T > qFindChildren (const QObject *obj, const QRegExp &regExp)
QList< T > qFindChildren (const QObject *obj, const QString &name)
qobject_cast (const QObject *object)
qobject_cast (QObject *object)
void removeEventFilter (QObject *obj)
void setObjectName (const QString &name)
void setParent (QObject *parent)
bool setProperty (const char *name, const QVariant &value)
bool signalsBlocked () const const
int startTimer (int interval, Qt::TimerType timerType)
int startTimer (std::chrono::milliseconds time, Qt::TimerType timerType)
QThreadthread () const const
- Public Member Functions inherited from QPaintDevice
int colorCount () const const
int depth () const const
int devicePixelRatio () const const
qreal devicePixelRatioF () const const
int height () const const
int heightMM () const const
int logicalDpiX () const const
int logicalDpiY () const const
bool paintingActive () const const
int physicalDpiX () const const
int physicalDpiY () const const
int width () const const
int widthMM () const const

Protected Member Functions

void showEvent (QShowEvent *event) override
- Protected Member Functions inherited from KDialog
 KDialog (KDialogPrivate &dd, QWidget *parent, Qt::WindowFlags flags={})
void closeEvent (QCloseEvent *e) override
void hideEvent (QHideEvent *) override
void keyPressEvent (QKeyEvent *) override
- Protected Member Functions inherited from QDialog
virtual void contextMenuEvent (QContextMenuEvent *e) override
virtual bool eventFilter (QObject *o, QEvent *e) override
virtual void resizeEvent (QResizeEvent *) override
- Protected Member Functions inherited from QWidget
virtual void actionEvent (QActionEvent *event)
virtual void changeEvent (QEvent *event)
void create (WId window, bool initializeWindow, bool destroyOldWindow)
void destroy (bool destroyWindow, bool destroySubWindows)
virtual void dragEnterEvent (QDragEnterEvent *event)
virtual void dragLeaveEvent (QDragLeaveEvent *event)
virtual void dragMoveEvent (QDragMoveEvent *event)
virtual void dropEvent (QDropEvent *event)
virtual void enterEvent (QEvent *event)
virtual bool event (QEvent *event) override
virtual void focusInEvent (QFocusEvent *event)
bool focusNextChild ()
virtual bool focusNextPrevChild (bool next)
virtual void focusOutEvent (QFocusEvent *event)
bool focusPreviousChild ()
virtual void initPainter (QPainter *painter) const const override
virtual void inputMethodEvent (QInputMethodEvent *event)
virtual void keyReleaseEvent (QKeyEvent *event)
virtual void leaveEvent (QEvent *event)
virtual int metric (QPaintDevice::PaintDeviceMetric m) const const override
virtual void mouseDoubleClickEvent (QMouseEvent *event)
virtual void mouseMoveEvent (QMouseEvent *event)
virtual void mousePressEvent (QMouseEvent *event)
virtual void mouseReleaseEvent (QMouseEvent *event)
virtual void moveEvent (QMoveEvent *event)
virtual bool nativeEvent (const QByteArray &eventType, void *message, long *result)
virtual void paintEvent (QPaintEvent *event)
virtual void tabletEvent (QTabletEvent *event)
void updateMicroFocus ()
virtual void wheelEvent (QWheelEvent *event)
- Protected Member Functions inherited from QObject
virtual void childEvent (QChildEvent *event)
virtual void connectNotify (const QMetaMethod &signal)
virtual void customEvent (QEvent *event)
virtual void disconnectNotify (const QMetaMethod &signal)
bool isSignalConnected (const QMetaMethod &signal) const const
int receivers (const char *signal) const const
QObjectsender () const const
int senderSignalIndex () const const
virtual void timerEvent (QTimerEvent *event)

Additional Inherited Members

- Public Types inherited from KDialog
enum  ButtonCode {
  None = 0x00000000, Help = 0x00000001, Default = 0x00000002, Ok = 0x00000004,
  Apply = 0x00000008, Try = 0x00000010, Cancel = 0x00000020, Close = 0x00000040,
  No = 0x00000080, Yes = 0x00000100, Reset = 0x00000200, Details = 0x00000400,
  User1 = 0x00001000, User2 = 0x00002000, User3 = 0x00004000, NoDefault = 0x00008000
typedef QFlags< ButtonCodeButtonCodes
enum  ButtonPopupMode { InstantPopup = 0, DelayedPopup = 1 }
typedef QFlags< ButtonPopupMode > ButtonPopupModes
enum  CaptionFlag { NoCaptionFlags = 0, AppNameCaption = 1, ModifiedCaption = 2, HIGCompliantCaption = AppNameCaption }
typedef QFlags< CaptionFlag > CaptionFlags
- Public Types inherited from QDialog
enum  DialogCode
- Public Types inherited from QWidget
enum  RenderFlag
- Public Types inherited from QPaintDevice
enum  PaintDeviceMetric
- Properties inherited from QDialog
- Properties inherited from QWidget
- Properties inherited from QObject
- Signals inherited from KDialog
void aboutToShowDetails ()
void applyClicked ()
void buttonClicked (KDialog::ButtonCode button)
void cancelClicked ()
void closeClicked ()
void defaultClicked ()
void finished ()
void helpClicked ()
void hidden ()
void layoutHintChanged ()
void noClicked ()
void okClicked ()
void resetClicked ()
void tryClicked ()
void user1Clicked ()
void user2Clicked ()
void user3Clicked ()
void yesClicked ()
- Public Slots inherited from KDialog
void delayedDestruct ()
void enableButton (ButtonCode id, bool state)
void enableButtonApply (bool state)
void enableButtonCancel (bool state)
void enableButtonOk (bool state)
void enableLinkedHelp (bool state)
bool isDetailsWidgetVisible () const
virtual void setCaption (const QString &caption)
virtual void setCaption (const QString &caption, bool modified)
void setDetailsWidget (QWidget *detailsWidget)
void setDetailsWidgetVisible (bool visible)
void setHelp (const QString &anchor, const QString &appname=QString())
void setHelpLinkText (const QString &text)
virtual void setPlainCaption (const QString &caption)
- Static Public Member Functions inherited from KDialog
static bool avoidArea (QWidget *widget, const QRect &area, int screen=-1)
static void centerOnScreen (QWidget *widget, int screen=-1)
static int groupSpacingHint ()
static QString makeStandardCaption (const QString &userCaption, QWidget *window=nullptr, CaptionFlags flags=HIGCompliantCaption)
static int marginHint ()
static void resizeLayout (QLayout *lay, int margin, int spacing)
static void resizeLayout (QWidget *widget, int margin, int spacing)
static void setAllowEmbeddingInGraphicsView (bool allowEmbedding)
static int spacingHint ()
- Static Public Member Functions inherited from QWidget
QWidgetcreateWindowContainer (QWindow *window, QWidget *parent, Qt::WindowFlags flags)
QWidgetfind (WId id)
QWidgetkeyboardGrabber ()
QWidgetmouseGrabber ()
void setTabOrder (QWidget *first, QWidget *second)
- Static Public Member Functions inherited from QObject
QMetaObject::Connection connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool disconnect (const QMetaObject::Connection &connection)
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
bool disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString tr (const char *sourceText, const char *disambiguation, int n)
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
- Public Attributes inherited from QDialog
- Public Attributes inherited from QWidget
typedef RenderFlags
- Public Attributes inherited from QObject
typedef QObjectList
- Public Attributes inherited from QPaintDevice
- Protected Slots inherited from KDialog
virtual void slotButtonClicked (int button)
void updateGeometry ()
- Protected Attributes inherited from KDialog
KDialogPrivate *const d_ptr

Detailed Description

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();

KDE Progress Dialog
Aaron J. Seigo
Urs Wolfer uwolfer @
since 5.0, use QProgressDialog instead

Definition at line 50 of file kprogressdialog.h.

Constructor & Destructor Documentation

◆ KProgressDialog()

KProgressDialog::KProgressDialog ( QWidget parent = nullptr,
const QString caption = QString(),
const QString text = QString(),
Qt::WindowFlags  flags = {} 

Constructs a KProgressDialog.

parentParent of the widget
captionText to display in window title bar
textText to display in the dialog
flagsThe widget flags

Definition at line 61 of file kprogressdialog.cpp.

◆ ~KProgressDialog()

KProgressDialog::~KProgressDialog ( )


Definition at line 92 of file kprogressdialog.cpp.

Member Function Documentation

◆ allowCancel()

bool KProgressDialog::allowCancel ( ) const

Returns true if the dialog can be canceled, false otherwise.

Definition at line 152 of file kprogressdialog.cpp.

◆ autoClose()

bool KProgressDialog::autoClose ( ) const

Returns true if the dialog will close upon completion, or false otherwise.

Definition at line 182 of file kprogressdialog.cpp.

◆ autoReset()

bool KProgressDialog::autoReset ( ) const

Returns true if the QProgressBar widget will be reset upon completion, or false otherwise.

Definition at line 192 of file kprogressdialog.cpp.

◆ buttonText()

QString KProgressDialog::buttonText ( ) const

Returns the text on the cancel button.

Definition at line 208 of file kprogressdialog.cpp.

◆ ignoreCancel()

void KProgressDialog::ignoreCancel ( )

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?"

Definition at line 126 of file kprogressdialog.cpp.

◆ labelText()

QString KProgressDialog::labelText ( ) const

Returns the current dialog text.

Definition at line 172 of file kprogressdialog.cpp.

◆ minimumDuration()

int KProgressDialog::minimumDuration ( ) const

Returns the time that must pass before the dialog appears.

See also

Definition at line 141 of file kprogressdialog.cpp.

◆ progressBar() [1/2]

const QProgressBar * KProgressDialog::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.

Definition at line 157 of file kprogressdialog.cpp.

◆ progressBar() [2/2]

const QProgressBar* KProgressDialog::progressBar ( ) const

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.

◆ setAllowCancel()

void KProgressDialog::setAllowCancel ( bool  allowCancel)

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.

allowCancelSet to true to make the dialog non-closable

Definition at line 146 of file kprogressdialog.cpp.

◆ setAutoClose()

void KProgressDialog::setAutoClose ( bool  close)

Sets whether the dialog should close automagically when all the steps in the QProgressBar have been completed.

The default is true.

Definition at line 187 of file kprogressdialog.cpp.

◆ setAutoReset()

void KProgressDialog::setAutoReset ( bool  autoReset)

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.

Definition at line 197 of file kprogressdialog.cpp.

◆ setButtonText()

void KProgressDialog::setButtonText ( const QString text)

Sets the text to appear on the cancel button.

Definition at line 202 of file kprogressdialog.cpp.

◆ setLabelText()

void KProgressDialog::setLabelText ( const QString text)

Sets the text in the dialog.

textthe text to display

Definition at line 167 of file kprogressdialog.cpp.

◆ setMinimumDuration()

void KProgressDialog::setMinimumDuration ( int  ms)

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.

Definition at line 131 of file kprogressdialog.cpp.

◆ showCancelButton()

void KProgressDialog::showCancelButton ( bool  show)

Sets whether the cancel button is visible.

setAllowCancel(false) implies showCancelButton(false)

The default is true.

showWhether or not the cancel button should be shown

Definition at line 177 of file kprogressdialog.cpp.

◆ wasCancelled()

bool KProgressDialog::wasCancelled ( ) const

Returns true if the dialog was closed or canceled before completion.

If the dialog is not cancellable it will always return false.

Definition at line 121 of file kprogressdialog.cpp.

The documentation for this class was generated from the following files:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon May 8 2023 03:56:01 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.