QgsFeedback Class Reference

Base class for feedback objects to be used for cancellation of something running in a worker thread. More...

#include <qgsfeedback.h>

Inheritance diagram for QgsFeedback:

Public Slots
void	cancel ()
	Tells the internal routines that the current operation should be canceled. This should be run by the main thread. More...

Signals
void	canceled ()
	Internal routines can connect to this signal if they use event loop. More...
void	progressChanged (double progress)
	Emitted when the feedback object reports a progress change. More...

Public Member Functions
	QgsFeedback (QObject *parent=nullptr)
	Construct a feedback object. More...
bool	isCanceled () const
	Tells whether the operation has been canceled already. More...
double	progress () const
	Returns the current progress reported by the feedback object. More...
void	setProgress (double progress)
	Sets the current progress for the feedback object. More...

Detailed Description

Base class for feedback objects to be used for cancellation of something running in a worker thread.

The class may be used as is or it may be subclassed for extended functionality for a particular operation (e.g. report progress or pass some data for preview).

When cancel() is called, the internal code has two options to check for cancellation state:

• if the worker thread uses an event loop (e.g. for network communication), the code can make a queued connection to canceled() signal and handle the cancellation in its slot.
• if the worker thread does not use an event loop, it can poll isCanceled() method regularly to see if the operation should be canceled.

The class is meant to be created and destroyed in the main thread.

For map rendering, the object may be created in constructor of a QgsMapLayerRenderer subclass and available with QgsMapLayerRenderer::feedback() method. When a map rendering job gets canceled, the cancel() method is called on the feedback object of all layers.

Since

QGIS 3.0

Definition at line 43 of file qgsfeedback.h.

Constructor & Destructor Documentation

QgsFeedback()

QgsFeedback::QgsFeedback ( QObject *  parent = nullptr )

inline

Construct a feedback object.

Definition at line 48 of file qgsfeedback.h.

Member Function Documentation

cancel

void QgsFeedback::cancel ( )

inlineslot

Tells the internal routines that the current operation should be canceled. This should be run by the main thread.

Definition at line 84 of file qgsfeedback.h.

canceled

void QgsFeedback::canceled ( )

signal

Internal routines can connect to this signal if they use event loop.

isCanceled()

bool QgsFeedback::isCanceled ( ) const

inline

Tells whether the operation has been canceled already.

Definition at line 53 of file qgsfeedback.h.

progress()

double QgsFeedback::progress ( ) const

inline

Returns the current progress reported by the feedback object.

Depending on how the feedback object is used progress reporting may not be supported. The returned value is in percentage and ranges from 0-100.

See also

setProgress()

progressChanged()

Since

QGIS 3.0

Definition at line 79 of file qgsfeedback.h.

progressChanged

void QgsFeedback::progressChanged ( double  progress )

signal

Emitted when the feedback object reports a progress change.

Depending on how the feedback object is used progress reporting may not be supported. The progress argument is in percentage and ranges from 0-100.

See also

setProgress()

progress()

Since

QGIS 3.0

setProgress()

void QgsFeedback::setProgress ( double  progress )

inline

Sets the current progress for the feedback object.

The progress argument is in percentage and valid values range from 0-100.

See also

progress()

progressChanged()

Since

QGIS 3.0

Definition at line 62 of file qgsfeedback.h.

---

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

• /build/qgis-3.16.0+99unstable/src/core/qgsfeedback.h