ACF $AcfVersion:0$
Public Member Functions | List of all members
ibase::IProgressManager Class Referenceabstract

Consume information about progress of some process. More...

#include <IProgressManager.h>

Inheritance diagram for ibase::IProgressManager:
istd::IPolymorphic ibase::CCumulatedProgressManagerBase iqtgui::CProgressDialog iqtgui::CProgressGuiBridge iqtgui::CProgressManagerGuiComp iqtgui::CSubtaskProgressDialog

Public Member Functions

virtual void ResetProgressManager ()=0
 Reset progress manager and make it possible to reuse it.
 
virtual std::unique_ptr< IProgressManagerCreateSubtaskManager (const QByteArray &taskId, const QString &taskDescription, double weight=1.0)=0
 Create progress manager for the subtask.
 
virtual std::unique_ptr< IProgressLoggerStartProgressLogger (bool isCancelable=false, const QString &description={})=0
 Create progress logger.
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Detailed Description

Consume information about progress of some process.

Definition at line 25 of file IProgressManager.h.

Member Function Documentation

◆ CreateSubtaskManager()

virtual std::unique_ptr< IProgressManager > ibase::IProgressManager::CreateSubtaskManager ( const QByteArray &  taskId,
const QString &  taskDescription,
double  weight = 1.0 
)
pure virtual

Create progress manager for the subtask.

This function should be called up at the start of the task for all subtasks.

Parameters
taskIdunique ID of this task. This ID can be used by the progress bar to distinguish between different tasks.
taskDescriptionhuman readable description of this task.
weightweight value

Implemented in ibase::CCumulatedProgressManagerBase.

◆ ResetProgressManager()

virtual void ibase::IProgressManager::ResetProgressManager ( )
pure virtual

Reset progress manager and make it possible to reuse it.

Implemented in ibase::CCumulatedProgressManagerBase.

◆ StartProgressLogger()

virtual std::unique_ptr< IProgressLogger > ibase::IProgressManager::StartProgressLogger ( bool  isCancelable = false,
const QString &  description = {} 
)
pure virtual

Create progress logger.

This function should be called once at the start of the task if it provides progress information.

Parameters
isCancelableinforms, that this task can be cancel during the processing.

Implemented in ibase::CCumulatedProgressManagerBase.


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