Class: QgsRasterBlockFeedback

class qgis.core.QgsRasterBlockFeedback

Bases: QgsFeedback

Feedback object tailored for raster block reading.

New in version 3.0.

QgsRasterBlockFeedback(parent: QObject = None) Construct a new raster block feedback object

Methods

appendError

Appends an error message to the stored list of errors.

childEvent

connectNotify

customEvent

disconnectNotify

errors

Returns a list of any errors encountered while retrieving the raster block.

isPreviewOnly

Whether the raster provider should return only data that are already available without waiting for full result.

isSignalConnected

onNewData

May be emitted by raster data provider to indicate that some partial data are available and a new preview image may be produced

receivers

renderContext

Returns the render context of the associated block reading

renderPartialOutput

Whether our painter is drawing to a temporary image used just by this layer

sender

senderSignalIndex

setPreviewOnly

set flag whether the block request is for preview purposes only

setRenderContext

Sets the render context of the associated block reading

setRenderPartialOutput

Set whether our painter is drawing to a temporary image used just by this layer

timerEvent

appendError(self, error: str)

Appends an error message to the stored list of errors. Should be called whenever an error is encountered while retrieving a raster block.

See also

errors()

New in version 3.8.0.

Parameters

error (str) –

childEvent(self, QChildEvent)
connectNotify(self, QMetaMethod)
customEvent(self, QEvent)
disconnectNotify(self, QMetaMethod)
errors(self) List[str]

Returns a list of any errors encountered while retrieving the raster block.

See also

appendError()

New in version 3.8.0.

Return type

List[str]

isPreviewOnly(self) bool

Whether the raster provider should return only data that are already available without waiting for full result. By default this flag is not enabled.

See also

setPreviewOnly()

Return type

bool

isSignalConnected(self, QMetaMethod) bool
onNewData(self)

May be emitted by raster data provider to indicate that some partial data are available and a new preview image may be produced

receivers(self, PYQT_SIGNAL) int
renderContext(self) QgsRenderContext

Returns the render context of the associated block reading

New in version 3.24.0.

Return type

QgsRenderContext

renderPartialOutput(self) bool

Whether our painter is drawing to a temporary image used just by this layer

Return type

bool

sender(self) QObject
senderSignalIndex(self) int
setPreviewOnly(self, preview: bool)

set flag whether the block request is for preview purposes only

See also

isPreviewOnly()

Parameters

preview (bool) –

setRenderContext(self, renderContext: QgsRenderContext)

Sets the render context of the associated block reading

See also

renderContext()

New in version 3.24.0.

Parameters

renderContext (QgsRenderContext) –

setRenderPartialOutput(self, enable: bool)

Set whether our painter is drawing to a temporary image used just by this layer

Parameters

enable (bool) –

timerEvent(self, QTimerEvent)