te::common::AbstractProgressViewer Class Referenceabstract

A class that defines the interface of an abstract progress viewer. More...

#include <AbstractProgressViewer.h>

Inheritance diagram for te::common::AbstractProgressViewer:
te::common::ConsoleProgressViewer te::qt::widgets::ProgressViewerBar te::qt::widgets::ProgressViewerDialog te::qt::widgets::ProgressViewerTaskWidget te::qt::widgets::ProgressViewerWidget

Public Member Functions

 AbstractProgressViewer ()
 Default constructor. More...
 
virtual void addTask (TaskProgress *t, int id)=0
 Insert a new task in the progress viewer. More...
 
virtual void cancelTask (int taskId)=0
 Cancel a task. More...
 
virtual void removeTask (int taskId)=0
 Removes a task from progress viewer container. More...
 
virtual void setTotalValues (int taskId)=0
 Set task total steps. More...
 
virtual void updateMessage (int taskId)=0
 Update the progress message. More...
 
virtual void updateValue (int taskId)=0
 Update the progress evaluation. More...
 
virtual ~AbstractProgressViewer ()
 Virtual destructor. More...
 

Protected Attributes

int m_viewerId
 

Detailed Description

A class that defines the interface of an abstract progress viewer.

See also
TaskProgress, ProgressManager

Definition at line 48 of file AbstractProgressViewer.h.

Constructor & Destructor Documentation

◆ AbstractProgressViewer()

te::common::AbstractProgressViewer::AbstractProgressViewer ( )

Default constructor.

◆ ~AbstractProgressViewer()

virtual te::common::AbstractProgressViewer::~AbstractProgressViewer ( )
virtual

Virtual destructor.

Member Function Documentation

◆ addTask()

virtual void te::common::AbstractProgressViewer::addTask ( TaskProgress t,
int  id 
)
pure virtual

Insert a new task in the progress viewer.

Parameters
tTask pointer.
idTask identifier.
Note
The Progress Viewer will NOT take the ownership of TaskProgress (t).

Implemented in te::qt::widgets::ProgressViewerBar, te::qt::widgets::ProgressViewerDialog, te::qt::widgets::ProgressViewerWidget, te::qt::widgets::ProgressViewerTaskWidget, and te::common::ConsoleProgressViewer.

◆ cancelTask()

virtual void te::common::AbstractProgressViewer::cancelTask ( int  taskId)
pure virtual

◆ removeTask()

virtual void te::common::AbstractProgressViewer::removeTask ( int  taskId)
pure virtual

◆ setTotalValues()

virtual void te::common::AbstractProgressViewer::setTotalValues ( int  taskId)
pure virtual

◆ updateMessage()

virtual void te::common::AbstractProgressViewer::updateMessage ( int  taskId)
pure virtual

◆ updateValue()

virtual void te::common::AbstractProgressViewer::updateValue ( int  taskId)
pure virtual

Member Data Documentation

◆ m_viewerId

int te::common::AbstractProgressViewer::m_viewerId
protected

Definition at line 105 of file AbstractProgressViewer.h.


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