QGIS API Documentation  2.18.21-Las Palmas (9fba24a)
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...
 
virtual ~QgsFeedback ()
 
void cancel ()
 Tells the internal routines that the current operation should be cancelled. This should be run by the main thread. More...
 
bool isCancelled () const
 Tells whether the operation has been cancelled already. More...
 
- Public Member Functions inherited from QObject
 QObject (QObject *parent)
 
 QObject (QObject *parent, const char *name)
 
virtual ~QObject ()
 
bool blockSignals (bool block)
 
QObjectchild (const char *objName, const char *inheritsClass, bool recursiveSearch) const
 
const QObjectList & children () const
 
const char * className () const
 
bool connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const
 
void deleteLater ()
 
void destroyed (QObject *obj)
 
bool disconnect (const QObject *receiver, const char *method)
 
bool disconnect (const char *signal, const QObject *receiver, const char *method)
 
void dumpObjectInfo ()
 
void dumpObjectTree ()
 
QList< QByteArraydynamicPropertyNames () const
 
virtual bool event (QEvent *e)
 
virtual bool eventFilter (QObject *watched, QEvent *event)
 
findChild (const QString &name) const
 
QList< T > findChildren (const QRegExp &regExp) const
 
QList< T > findChildren (const QString &name) const
 
bool inherits (const char *className) const
 
void insertChild (QObject *object)
 
void installEventFilter (QObject *filterObj)
 
bool isA (const char *className) const
 
bool isWidgetType () const
 
void killTimer (int id)
 
virtual const QMetaObjectmetaObject () const
 
void moveToThread (QThread *targetThread)
 
const char * name () const
 
const char * name (const char *defaultName) const
 
QString objectName () const
 
QObjectparent () const
 
QVariant property (const char *name) const
 
void removeChild (QObject *object)
 
void removeEventFilter (QObject *obj)
 
void setName (const char *name)
 
void setObjectName (const QString &name)
 
void setParent (QObject *parent)
 
bool setProperty (const char *name, const QVariant &value)
 
bool signalsBlocked () const
 
int startTimer (int interval)
 
QThreadthread () const
 

Additional Inherited Members

- Signals inherited from QgsFeedback
void cancelled ()
 Internal routines can connect to this signal if they use event loop. More...
 
- Static Public Member Functions inherited from QObject
bool connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
 
bool connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
 
bool disconnect (const QObject *sender, const char *signal, const QObject *receiver, const char *method)
 
bool disconnect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method)
 
QString tr (const char *sourceText, const char *disambiguation, int n)
 
QString trUtf8 (const char *sourceText, const char *disambiguation, int n)
 
- Protected Member Functions inherited from QObject
bool checkConnectArgs (const char *signal, const QObject *object, const char *method)
 
virtual void childEvent (QChildEvent *event)
 
virtual void connectNotify (const char *signal)
 
virtual void customEvent (QEvent *event)
 
virtual void disconnectNotify (const char *signal)
 
int receivers (const char *signal) const
 
QObjectsender () const
 
int senderSignalIndex () const
 
virtual void timerEvent (QTimerEvent *event)
 
- Static Protected Member Functions inherited from QObject
QByteArray normalizeSignalSlot (const char *signalSlot)
 
- Properties inherited from QObject
 objectName
 

Detailed Description

Feedback object tailored for raster block reading.

Note
added in QGIS 2.18

Definition at line 38 of file qgsrasterinterface.h.

Constructor & Destructor Documentation

◆ QgsRasterBlockFeedback()

QgsRasterBlockFeedback::QgsRasterBlockFeedback ( QObject parent = nullptr)
inline

Construct a new raster block feedback object.

Definition at line 42 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 51 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 46 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 58 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 54 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 61 of file qgsrasterinterface.h.


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