QgsLabelingEngineFeedback Class Reference

QgsFeedback subclass for granular reporting of labeling engine progress. More...

#include <qgslabelingengine.h>

Inheritance diagram for QgsLabelingEngineFeedback:

Signals
void	calculatingConflictsAboutToBegin ()
	Emitted when the conflict handling step is about to begin.
void	calculatingConflictsFinished ()
	Emitted when the conflict handling step has completed.
void	candidateCreationAboutToBegin (QgsAbstractLabelProvider *provider)
	Emitted when the label candidate creation is about to begin for a provider.
void	candidateCreationFinished (QgsAbstractLabelProvider *provider)
	Emitted when the label candidate creation has completed for a provider.
void	finalizingCandidatesAboutToBegin ()
	Emitted when the label candidates are about to be finalized.
void	finalizingCandidatesFinished ()
	Emitted when the label candidates are finalized.
void	labelRegistrationAboutToBegin ()
	Emitted when the label registration is about to begin.
void	labelRegistrationFinished ()
	Emitted when the label registration has completed for all providers.
void	obstacleCostingAboutToBegin ()
	Emitted when the obstacle costing is about to begin.
void	obstacleCostingFinished ()
	Emitted when the obstacle costing has completed.
void	providerRegistrationAboutToBegin (QgsAbstractLabelProvider *provider)
	Emitted when the label registration is about to begin for a provider.
void	providerRegistrationFinished (QgsAbstractLabelProvider *provider)
	Emitted when the label registration has completed for a provider.
void	reductionAboutToBegin ()
	Emitted when the candidate reduction step is about to begin.
void	reductionFinished ()
	Emitted when the candidate reduction step is finished.
void	solvingPlacementAboutToBegin ()
	Emitted when the problem solving step is about to begin.
void	solvingPlacementFinished ()
	Emitted when the problem solving step is finished.
Signals inherited from QgsFeedback
void	canceled ()
	Internal routines can connect to this signal if they use event loop.
void	processedCountChanged (unsigned long long processedCount)
	Emitted when the feedback object reports a change in the number of processed objects.
void	progressChanged (double progress)
	Emitted when the feedback object reports a progress change.

Public Member Functions
	QgsLabelingEngineFeedback (QObject *parent=nullptr)
	Constructor for QgsLabelingEngineFeedback, with the specified parent object.
Public Member Functions inherited from QgsFeedback
	QgsFeedback (QObject *parent=nullptr)
	Construct a feedback object.
bool	isCanceled () const
	Tells whether the operation has been canceled already.
unsigned long long	processedCount () const
	Returns the current processed objects count reported by the feedback object.
double	progress () const
	Returns the current progress reported by the feedback object.
void	setProcessedCount (unsigned long long processedCount)
	Sets the current processed objects count for the feedback object.
void	setProgress (double progress)
	Sets the current progress for the feedback object.

Additional Inherited Members
Public Slots inherited from QgsFeedback
void	cancel ()
	Tells the internal routines that the current operation should be canceled. This should be run by the main thread.

Detailed Description

QgsFeedback subclass for granular reporting of labeling engine progress.

Note

not available in Python bindings

Since

QGIS 3.24

Definition at line 228 of file qgslabelingengine.h.

Constructor & Destructor Documentation

QgsLabelingEngineFeedback()

QgsLabelingEngineFeedback::QgsLabelingEngineFeedback ( QObject *  parent = nullptr )

inline

Constructor for QgsLabelingEngineFeedback, with the specified parent object.

Definition at line 237 of file qgslabelingengine.h.

Member Function Documentation

calculatingConflictsAboutToBegin

void QgsLabelingEngineFeedback::calculatingConflictsAboutToBegin ( )

signal

Emitted when the conflict handling step is about to begin.

calculatingConflictsFinished

void QgsLabelingEngineFeedback::calculatingConflictsFinished ( )

signal

Emitted when the conflict handling step has completed.

candidateCreationAboutToBegin

void QgsLabelingEngineFeedback::candidateCreationAboutToBegin ( QgsAbstractLabelProvider *  provider )

signal

Emitted when the label candidate creation is about to begin for a provider.

candidateCreationFinished

void QgsLabelingEngineFeedback::candidateCreationFinished ( QgsAbstractLabelProvider *  provider )

signal

Emitted when the label candidate creation has completed for a provider.

finalizingCandidatesAboutToBegin

void QgsLabelingEngineFeedback::finalizingCandidatesAboutToBegin ( )

signal

Emitted when the label candidates are about to be finalized.

finalizingCandidatesFinished

void QgsLabelingEngineFeedback::finalizingCandidatesFinished ( )

signal

Emitted when the label candidates are finalized.

labelRegistrationAboutToBegin

void QgsLabelingEngineFeedback::labelRegistrationAboutToBegin ( )

signal

Emitted when the label registration is about to begin.

labelRegistrationFinished

void QgsLabelingEngineFeedback::labelRegistrationFinished ( )

signal

Emitted when the label registration has completed for all providers.

obstacleCostingAboutToBegin

void QgsLabelingEngineFeedback::obstacleCostingAboutToBegin ( )

signal

Emitted when the obstacle costing is about to begin.

obstacleCostingFinished

void QgsLabelingEngineFeedback::obstacleCostingFinished ( )

signal

Emitted when the obstacle costing has completed.

providerRegistrationAboutToBegin

void QgsLabelingEngineFeedback::providerRegistrationAboutToBegin ( QgsAbstractLabelProvider *  provider )

signal

Emitted when the label registration is about to begin for a provider.

providerRegistrationFinished

void QgsLabelingEngineFeedback::providerRegistrationFinished ( QgsAbstractLabelProvider *  provider )

signal

Emitted when the label registration has completed for a provider.

reductionAboutToBegin

void QgsLabelingEngineFeedback::reductionAboutToBegin ( )

signal

Emitted when the candidate reduction step is about to begin.

reductionFinished

void QgsLabelingEngineFeedback::reductionFinished ( )

signal

Emitted when the candidate reduction step is finished.

solvingPlacementAboutToBegin

void QgsLabelingEngineFeedback::solvingPlacementAboutToBegin ( )

signal

Emitted when the problem solving step is about to begin.

solvingPlacementFinished

void QgsLabelingEngineFeedback::solvingPlacementFinished ( )

signal

Emitted when the problem solving step is finished.

---

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

• /build/qgis-3.41.0+git20241214+cea29feecf2+99sid/src/core/labeling/qgslabelingengine.h