QGIS API Documentation  3.25.0-Master (dec16ba68b)
Signals | Public Member Functions | List of all members
QgsLabelingEngineFeedback Class Reference

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

#include <qgslabelingengine.h>

Inheritance diagram for QgsLabelingEngineFeedback:
Inheritance graph
[legend]

Signals

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

Public Member Functions

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

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. More...
 

Detailed Description

QgsFeedback subclass for granular reporting of labeling engine progress.

Note
not available in Python bindings
Since
QGIS 3.24

Definition at line 212 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 221 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: