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::CDelegatedProgressManager iqtgui::CProgressManagerGuiComp

Public Member Functions

virtual int BeginProgressSession (const QByteArray &progressId, const QString &description, bool isCancelable=false)=0
 Begin progress report session. More...
 
virtual void EndProgressSession (int sessionId)=0
 Close progress report session. More...
 
virtual void OnProgress (int sessionId, double currentProgress)=0
 Callback function for a progress event. More...
 
virtual bool IsCanceled (int sessionId) const =0
 Check if this processing operation should be canceled. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Detailed Description

Consume information about progress of some process.

Definition at line 20 of file IProgressManager.h.

Member Function Documentation

virtual int ibase::IProgressManager::BeginProgressSession ( const QByteArray &  progressId,
const QString &  description,
bool  isCancelable = false 
)
pure virtual

Begin progress report session.

Returns
session ID or negative value if failed.

Implemented in ibase::CDelegatedProgressManager, and iqtgui::CProgressManagerGuiComp.

virtual void ibase::IProgressManager::EndProgressSession ( int  sessionId)
pure virtual

Close progress report session.

Parameters
sessionIdsession ID returned by BeginProgressSession.

Implemented in ibase::CDelegatedProgressManager.

virtual bool ibase::IProgressManager::IsCanceled ( int  sessionId) const
pure virtual

Check if this processing operation should be canceled.

Parameters
sessionIdsession ID returned by BeginProgressSession.

Implemented in ibase::CDelegatedProgressManager, and iqtgui::CProgressManagerGuiComp.

virtual void ibase::IProgressManager::OnProgress ( int  sessionId,
double  currentProgress 
)
pure virtual

Callback function for a progress event.

Parameters
sessionIdsession ID returned by BeginProgressSession.

Implemented in ibase::CDelegatedProgressManager.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy