RibbonProgressOperation Class
RibbonProgressOperation implements the ability to perform long operations in a separate thread without blocking the main GUI thread. More...
Header: | #include <RibbonProgressOperation> |
Inherits: | QObject |
Public Functions
RibbonProgressOperation(QObject *parent = Q_NULL) | |
virtual | ~RibbonProgressOperation() override |
bool | isRunning() const |
bool | start(RibbonProgressData *data, RibbonProgressBar *progressBar = Q_NULL) |
void | stop() |
Detailed Description
Member Function Documentation
[explicit]
RibbonProgressOperation::RibbonProgressOperation(QObject *parent = Q_NULL)
Constructs RibbonProgressOperation object with the given parent.
[override virtual noexcept]
RibbonProgressOperation::~RibbonProgressOperation()
bool RibbonProgressOperation::isRunning() const
Returns true if operation is running, otherwise false.
bool RibbonProgressOperation::start(RibbonProgressData *data, RibbonProgressBar *progressBar = Q_NULL)
Starts the operation if it is not running yet. Parameter data is used to pass the context for the operation. Paratemeter progressBar is a progress bar that sould be updated while the operation is performing.
void RibbonProgressOperation::stop()
Terminates the operation's thread and wait while the thread it is ending.