Subgroup: Processing

Class: QgsProcessingMultiStepFeedback

class qgis.core.QgsProcessingMultiStepFeedback

Bases: qgis._core.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.

New in version 3.0: Methods

blockSignals
cancel Tells the internal routines that the current operation should be canceled.
childEvent
children
connectNotify
customEvent
deleteLater
disconnect
disconnectNotify
dumpObjectInfo
dumpObjectTree
dynamicPropertyNames
event
eventFilter
findChild findChild(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> QObject
findChildren findChildren(self, Tuple, name: str = ‘’, options: Union[Qt.FindChildOptions, Qt.FindChildOption] = Qt.FindChildrenRecursively) -> List[QObject]
inherits
installEventFilter
isCanceled Tells whether the operation has been canceled already
isSignalConnected
isWidgetType
isWindowType
killTimer
metaObject
moveToThread
objectName
parent
progress Returns the current progress reported by the feedback object.
property
pushCommandInfo
pushConsoleInfo
pushDebugInfo
pushInfo
pyqtConfigure Each keyword argument is either the name of a Qt property or a Qt signal.
receivers
removeEventFilter
reportError
sender
senderSignalIndex
setCurrentStep Sets the step which is being executed.
setObjectName
setParent
setProgress Sets the current progress for the feedback object.
setProgressText
setProperty
signalsBlocked
startTimer
thread
timerEvent
tr

Attributes

canceled Internal routines can connect to this signal if they use event loop [signal]
destroyed destroyed(self, QObject = None) [signal]
objectNameChanged objectNameChanged(self, str) [signal]
progressChanged Emitted when the feedback object reports a progress change.
staticMetaObject
childEvent()
connectNotify()
customEvent()
disconnectNotify()
isSignalConnected()
pushCommandInfo(self, info: str)
pushConsoleInfo(self, info: str)
pushDebugInfo(self, info: str)
pushInfo(self, info: str)
receivers()
reportError(self, error: str)
sender()
senderSignalIndex()
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.

setProgressText(self, text: str)
timerEvent()