ICF 3.0.5.47
Technical documentation of ICF Libraries
istdgui::CProgressDialog Class Reference

#include <CProgressDialog.h>

Inheritance diagram for istdgui::CProgressDialog:
Collaboration diagram for istdgui::CProgressDialog:

Public Types

typedef QProgressDialog BaseClass
 

Public Member Functions

 CProgressDialog (QWidget *parentWidget=nullptr)
 
virtual int BeginProgressSession (const QByteArray &progressId, const QString &description, bool isCancelable) override
 Begin progress report session.
 
void EndProgressSession (int sessionId) override
 Close progress report session.
 
void OnProgress (int sessionId, double currentProgress) override
 Callback function for a progress event.
 
bool IsCanceled (int sessionId) const override
 Check if this processing operation should be canceled.
 
- Public Member Functions inherited from iproc::IProgressManager

Detailed Description

Definition at line 20 of file CProgressDialog.h.

Member Typedef Documentation

◆ BaseClass

Definition at line 23 of file CProgressDialog.h.

Constructor & Destructor Documentation

◆ CProgressDialog()

istdgui::CProgressDialog::CProgressDialog ( QWidget * parentWidget = nullptr)

Member Function Documentation

◆ BeginProgressSession()

virtual int istdgui::CProgressDialog::BeginProgressSession ( const QByteArray & progressId,
const QString & description,
bool isCancelable )
overridevirtual

Begin progress report session.

Returns
session ID or negative value if failed.

Implements iproc::IProgressManager.

◆ EndProgressSession()

void istdgui::CProgressDialog::EndProgressSession ( int sessionId)
overridevirtual

Close progress report session.

Parameters
sessionIdsession ID returned by BeginProgressSession.

Implements iproc::IProgressManager.

◆ IsCanceled()

bool istdgui::CProgressDialog::IsCanceled ( int sessionId) const
overridevirtual

Check if this processing operation should be canceled.

Parameters
sessionIdsession ID returned by BeginProgressSession.

Implements iproc::IProgressManager.

◆ OnProgress()

void istdgui::CProgressDialog::OnProgress ( int sessionId,
double currentProgress )
overridevirtual

Callback function for a progress event.

Parameters
sessionIdsession ID returned by BeginProgressSession.

Implements iproc::IProgressManager.


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

© Witold Gantzke and Kirill Lepskiy