Class: QgsProcessingMultiStepFeedback

class qgis.core.QgsProcessingMultiStepFeedback

Bases: QgsProcessingFeedback

Processing feedback object for multi-step operations.

A processing feedback object which proxies its calls to an underlying feedback object, but scales overall progress reports to account for a number of child steps which each report their own feedback.

QgsProcessingMultiStepFeedback(steps: int, feedback: Optional[QgsProcessingFeedback]) Constructor for QgsProcessingMultiStepFeedback, for a process with the specified number of steps. This feedback object will proxy calls to the specified feedback object.

Methods

childEvent
connectNotify
customEvent
disconnectNotify
htmlLog	rtype: str
isSignalConnected
pushCommandInfo	param info:
pushConsoleInfo	param info:
pushDebugInfo	param info:
pushFormattedMessage	param html:
pushInfo	param info:
pushWarning	param warning:
receivers
reportError	param error:
sender
senderSignalIndex
setCurrentStep	Sets the step which is being executed.
setProgressText	param text:
textLog	rtype: str
timerEvent

childEvent(self, a0: QChildEvent | None)

connectNotify(self, signal: QMetaMethod)

customEvent(self, a0: QEvent | None)

disconnectNotify(self, signal: QMetaMethod)

htmlLog(self) → str

Return type:

str

isSignalConnected(self, signal: QMetaMethod) → bool

pushCommandInfo(self, info: str | None)

Parameters:

info (Optional[str])

pushConsoleInfo(self, info: str | None)

Parameters:

info (Optional[str])

pushDebugInfo(self, info: str | None)

Parameters:

info (Optional[str])

pushFormattedMessage(self, html: str | None, text: str | None)

Parameters:

• html (Optional[str])

• text (Optional[str])

pushInfo(self, info: str | None)

Parameters:

info (Optional[str])

pushWarning(self, warning: str | None)

Parameters:

warning (Optional[str])

receivers(self, signal: PYQT_SIGNAL) → int

reportError(self, error: str | None, fatalError: bool = False)

Parameters:

• error (Optional[str])

• fatalError (bool = False)

sender(self) → QObject | None

senderSignalIndex(self) → int

setCurrentStep(self, step: int)

Sets the step which is being executed. This is used to scale the current progress to account for progress through the overall process.

Parameters:

step (int)

setProgressText(self, text: str | None)

Parameters:

text (Optional[str])

textLog(self) → str

Return type:

str

timerEvent(self, a0: QTimerEvent | None)