LeechCraft  0.6.70-15082-g543737046d
Modular cross-platform feature rich live environment.
ILoadProgressReporter Class Referenceabstract

Interface for reporting progress of some long-running operation during load time. More...

#include "iloadprogressreporter.h"

Public Member Functions

virtual ~ILoadProgressReporter ()
 
virtual ILoadProcess_ptr InitiateProcess (const QString &title, int min, int max)=0
 Notifies about a specific long-running process during load. More...
 

Detailed Description

Interface for reporting progress of some long-running operation during load time.

This object can be used to track multiple operations at once. Each operation corresponds to an object returned by InitiateProcess() for that operation.

This object should be used by any plugin doing some long-running operation during LeechCraft load (like a DB migration) because of usability reasons.

See also
IPluginManager::CreateLoadProgressReporter()
ILoadProcess

Definition at line 50 of file iloadprogressreporter.h.

Constructor & Destructor Documentation

◆ ~ILoadProgressReporter()

virtual ILoadProgressReporter::~ILoadProgressReporter ( )
inlinevirtual

Definition at line 53 of file iloadprogressreporter.h.

Member Function Documentation

◆ InitiateProcess()

virtual ILoadProcess_ptr ILoadProgressReporter::InitiateProcess ( const QString &  title,
int  min,
int  max 
)
pure virtual

Notifies about a specific long-running process during load.

Parameters
[in]titleThe human-readable title of the operation.
[in]minThe initial number of steps already done.
[in]maxThe total number of steps that should be done by.
Returns
The object used to track this exact operation.

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