AsyncProgressDialog
Public Slots | Public Member Functions | List of all members
APD::ProgressWidget Class Reference

Base class for all widgets capable of displaying progress for a TaskThread. More...

Inheritance diagram for APD::ProgressWidget:
APD::ProgressBar APD::ProgressEstimate APD::ProgressLabel APD::ProgressOutput APD::ProgressVelocityPlot APD::ProgressWidgetContainer

Public Slots

virtual void setValue (int, const QVariant &, const TimeStamp &)
 
virtual void setRange (int, int)
 
virtual void setText (const QString &)
 

Public Member Functions

 ProgressWidget (QWidget *parent=nullptr)
 

Detailed Description

Base class for all widgets capable of displaying progress for a TaskThread.

When added to AsyncProgressDialog together with a TaskThread, the progress widget is automatically connected to the associated signals of TaskThread. The inherited progress widgets override some or all of the virtaul slots defined in this class in order to update their progress.

Progress widgets can be created using ProgressWidgetFactory.

See also
ProgressBar, ProgressEstimate, ProgressLabel, ProgressOutput, ProgressVelocity, ProgressWidgetContainer

Constructor & Destructor Documentation

◆ ProgressWidget()

APD::ProgressWidget::ProgressWidget ( QWidget *  parent = nullptr)
inlineexplicit

Constructs a progress widget with the given parent.

Member Function Documentation

◆ setRange

void APD::ProgressWidget::setRange ( int  minimum,
int  maximum 
)
inlinevirtualslot

A slot called when the range of associated TaskThread is updated.

See also
TaskThread::setRange()

◆ setText

void APD::ProgressWidget::setText ( const QString &  )
inlinevirtualslot

A slot called when the progress text of associated TaskThread is updated.

See also
TaskThread::setText()

◆ setValue

void APD::ProgressWidget::setValue ( int  value,
const QVariant &  userValue,
const TimeStamp &  timeStamp 
)
inlinevirtualslot

A slot called when the progress of associated TaskThread is updated. The timeStamp value is added by the TaskThread::setValue() method. The time stamp can be used to display time estimate. It must be obtained in the worker thread in order to be accurate.

See also
TaskThread::setValue()

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