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.

1. It adds support for an abort button that can be enabled to allow aborting for interruptible processing while progress in active.
2. It does not use QMacStyle on OsX instead uses "fusion" or "cleanlooks" show that the text is shown on the progress bar.
3. It does not render progress bar grove for a more "flat" look and avoid dramatic UI change when toggling between showing progress and not.

Definition at line 32 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 45 of file pqProgressWidget.h.

◆ abortButton()

QToolButton* pqProgressWidget::abortButton ( ) const

inline

Provides access to the abort button.

Definition at line 50 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 59 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 69 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 98 of file pqProgressWidget.h.

◆ AbortButton

QToolButton* pqProgressWidget::AbortButton

protected

Definition at line 99 of file pqProgressWidget.h.

Property Documentation

◆ readyText

QString pqProgressWidget::readyText

readwrite

Definition at line 36 of file pqProgressWidget.h.

◆ busyText

QString pqProgressWidget::busyText

readwrite

Definition at line 37 of file pqProgressWidget.h.

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

/builds/gitlab-kitware-sciviz-ci/Qt/Widgets/pqProgressWidget.h

Public Slots

Signals

Public Member Functions

Protected Member Functions

Protected Attributes

Properties

Detailed Description

Constructor & Destructor Documentation

◆ pqProgressWidget()

◆ ~pqProgressWidget()

Member Function Documentation

◆ getAbortButton()

◆ abortButton()

◆ setReadyText()

◆ readyText()

◆ setBusyText()

◆ busyText()

◆ setProgress

◆ enableProgress

◆ enableAbort

◆ abortPressed

◆ updateUI()

Member Data Documentation

◆ ProgressBar

◆ AbortButton

Property Documentation

◆ readyText

◆ busyText