QGIS API Documentation  2.99.0-Master (f867b65)
Public Member Functions | List of all members
QgsRasterBlockFeedback Class Reference

Feedback object tailored for raster block reading. More...

#include <qgsrasterinterface.h>

Inheritance diagram for QgsRasterBlockFeedback:
Inheritance graph
[legend]

Public Member Functions

 QgsRasterBlockFeedback (QObject *parent=nullptr)
 Construct a new raster block feedback object. More...
 
bool isPreviewOnly () const
 Whether the raster provider should return only data that are already available without waiting for full result. More...
 
virtual void onNewData ()
 May be emitted by raster data provider to indicate that some partial data are available and a new preview image may be produced. More...
 
bool renderPartialOutput () const
 Whether our painter is drawing to a temporary image used just by this layer. More...
 
void setPreviewOnly (bool preview)
 set flag whether the block request is for preview purposes only More...
 
void setRenderPartialOutput (bool enable)
 Set whether our painter is drawing to a temporary image used just by this layer. More...
 
- Public Member Functions inherited from QgsFeedback
 QgsFeedback (QObject *parent=nullptr)
 Construct a feedback object. More...
 
void cancel ()
 Tells the internal routines that the current operation should be canceled. This should be run by the main thread. More...
 
bool isCanceled () const
 Tells whether the operation has been canceled already. More...
 
double progress () const
 Returns the current progress reported by the feedback object. More...
 
void setProgress (double progress)
 Sets the current progress for the feedback object. More...
 

Additional Inherited Members

- Signals inherited from QgsFeedback
void canceled ()
 Internal routines can connect to this signal if they use event loop. More...
 
void progressChanged (double progress)
 Emitted when the feedback object reports a progress change. More...
 

Detailed Description

Feedback object tailored for raster block reading.

Since
QGIS 3.0

Definition at line 40 of file qgsrasterinterface.h.

Constructor & Destructor Documentation

◆ QgsRasterBlockFeedback()

QgsRasterBlockFeedback::QgsRasterBlockFeedback ( QObject *  parent = nullptr)
inline

Construct a new raster block feedback object.

Definition at line 44 of file qgsrasterinterface.h.

Member Function Documentation

◆ isPreviewOnly()

bool QgsRasterBlockFeedback::isPreviewOnly ( ) const
inline

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()

Definition at line 53 of file qgsrasterinterface.h.

◆ onNewData()

virtual void QgsRasterBlockFeedback::onNewData ( )
inlinevirtual

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

Reimplemented in QgsRasterLayerRenderer::Feedback.

Definition at line 48 of file qgsrasterinterface.h.

◆ renderPartialOutput()

bool QgsRasterBlockFeedback::renderPartialOutput ( ) const
inline

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

See also
setRenderPartialOutput()

Definition at line 60 of file qgsrasterinterface.h.

◆ setPreviewOnly()

void QgsRasterBlockFeedback::setPreviewOnly ( bool  preview)
inline

set flag whether the block request is for preview purposes only

See also
isPreviewOnly()

Definition at line 56 of file qgsrasterinterface.h.

◆ setRenderPartialOutput()

void QgsRasterBlockFeedback::setRenderPartialOutput ( bool  enable)
inline

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

See also
renderPartialOutput()

Definition at line 63 of file qgsrasterinterface.h.


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