Public Slots | Signals | Public Member Functions | Protected Member Functions | Protected Attributes | Properties | List of all members
pqProgressWidget Class Reference

widget to show progress in a QStatusBar. More...

#include <pqProgressWidget.h>

Inherits QWidget.

Public Slots

void setProgress (const QString &message, int value)
 Set the progress. More...
 
void enableProgress (bool enabled)
 Enabled/disable the progress. More...
 
void enableAbort (bool enabled)
 Enable/disable the abort button. More...
 

Signals

void abortPressed ()
 triggered with the abort button is pressed. More...
 

Public Member Functions

 pqProgressWidget (QWidget *parent=nullptr)
 
 ~pqProgressWidget () override
 
QToolButton * getAbortButton () const
 
QToolButton * abortButton () const
 Provides access to the abort button. More...
 
void setReadyText (const QString &)
 Set the text to use by default when the progress bar is not enabled which typically corresponds to application not being busy. More...
 
const QString & readyText () const
 Set the text to use by default when the progress bar is not enabled which typically corresponds to application not being busy. More...
 
void setBusyText (const QString &)
 Set the text to use by default when the progress bar is enabled which typically corresponds to application being busy. More...
 
const QString & busyText () const
 Set the text to use by default when the progress bar is enabled which typically corresponds to application being busy. More...
 

Protected Member Functions

void updateUI ()
 request Qt to paint the widgets. More...
 

Protected Attributes

pqProgressWidgetLabel * ProgressBar
 
QToolButton * AbortButton
 

Properties

QString readyText
 
QString busyText
 

Detailed Description

widget to show progress in a QStatusBar.

pqProgressWidget is a widget designed to be used in the QStatusBar of the application to show progress for time consuming tasks in the application.

pqProgressWidget is a replacement for QProgressBar. It has the following differences with QProgressBar.

Definition at line 60 of file pqProgressWidget.h.

Constructor & Destructor Documentation

◆ pqProgressWidget()

pqProgressWidget::pqProgressWidget ( QWidget *  parent = nullptr)

◆ ~pqProgressWidget()

pqProgressWidget::~pqProgressWidget ( )
override

Member Function Documentation

◆ getAbortButton()

QToolButton* pqProgressWidget::getAbortButton ( ) const
inline
Deprecated:
in ParaView 5.5.

Use abortButton instead.

Definition at line 73 of file pqProgressWidget.h.

◆ abortButton()

QToolButton* pqProgressWidget::abortButton ( ) const
inline

Provides access to the abort button.

Definition at line 78 of file pqProgressWidget.h.

◆ setReadyText()

void pqProgressWidget::setReadyText ( const QString &  )

Set the text to use by default when the progress bar is not enabled which typically corresponds to application not being busy.

Default value is empty.

◆ readyText()

const QString& pqProgressWidget::readyText ( ) const
inline

Set the text to use by default when the progress bar is not enabled which typically corresponds to application not being busy.

Default value is empty.

Definition at line 87 of file pqProgressWidget.h.

◆ setBusyText()

void pqProgressWidget::setBusyText ( const QString &  )

Set the text to use by default when the progress bar is enabled which typically corresponds to application being busy.

Default value is "Busy".

◆ busyText()

const QString& pqProgressWidget::busyText ( ) const
inline

Set the text to use by default when the progress bar is enabled which typically corresponds to application being busy.

Default value is "Busy".

Definition at line 97 of file pqProgressWidget.h.

◆ setProgress

void pqProgressWidget::setProgress ( const QString &  message,
int  value 
)
slot

Set the progress.

Progress must be enabled by calling 'enableProgress` otherwise this method will have no effect.

◆ enableProgress

void pqProgressWidget::enableProgress ( bool  enabled)
slot

Enabled/disable the progress.

This is different from enabling/disabling the widget itself. This shows/hides the progress part of the widget.

◆ enableAbort

void pqProgressWidget::enableAbort ( bool  enabled)
slot

Enable/disable the abort button.

◆ abortPressed

void pqProgressWidget::abortPressed ( )
signal

triggered with the abort button is pressed.

◆ updateUI()

void pqProgressWidget::updateUI ( )
protected

request Qt to paint the widgets.

Member Data Documentation

◆ ProgressBar

pqProgressWidgetLabel* pqProgressWidget::ProgressBar
protected

Definition at line 126 of file pqProgressWidget.h.

◆ AbortButton

QToolButton* pqProgressWidget::AbortButton
protected

Definition at line 127 of file pqProgressWidget.h.

Property Documentation

◆ readyText

QString pqProgressWidget::readyText
readwrite

Definition at line 64 of file pqProgressWidget.h.

◆ busyText

QString pqProgressWidget::busyText
readwrite

Definition at line 65 of file pqProgressWidget.h.


The documentation for this class was generated from the following file: