QgsExternalStorageContent Class Reference

Base class for QgsExternalStorage stored and fetched content. More...

#include <qgsexternalstorage.h>

Inheritance diagram for QgsExternalStorageContent:

Public Slots
virtual void	cancel ()
	Cancels content fetching/storing.

Signals
void	canceled ()
	The signal is emitted when content fetching/storing has been canceled.
void	errorOccurred (const QString &errorString)
	The signal is emitted when an error occurred.
void	progressChanged (double progress)
	The signal is emitted whenever content fetching/storing estimated progression value progress has changed.

Public Member Functions
const QString &	errorString () const
	Returns error textual description if an error occurred and status() returns Failed.
Qgis::ContentStatus	status () const
	Returns content status.

Protected Member Functions
void	reportError (const QString &errorMsg)
	Update content according to given errorMsg error message Inherited classes should call this method whenever they meet an error.
void	setStatus (Qgis::ContentStatus status)
	Sets the external storage status.

Protected Attributes
QString	mErrorString

Detailed Description

Base class for QgsExternalStorage stored and fetched content.

Since

QGIS 3.22

Definition at line 111 of file qgsexternalstorage.h.

Member Function Documentation

cancel

virtual void QgsExternalStorageContent::cancel ( )

inlinevirtualslot

Cancels content fetching/storing.

Definition at line 132 of file qgsexternalstorage.h.

canceled

void QgsExternalStorageContent::canceled ( )

signal

The signal is emitted when content fetching/storing has been canceled.

errorOccurred

void QgsExternalStorageContent::errorOccurred ( const QString &  errorString )

signal

The signal is emitted when an error occurred.

errorString is a textual description of the error

errorString()

const QString & QgsExternalStorageContent::errorString

(

)

const

Returns error textual description if an error occurred and status() returns Failed.

Definition at line 35 of file qgsexternalstorage.cpp.

progressChanged

void QgsExternalStorageContent::progressChanged ( double  progress )

signal

The signal is emitted whenever content fetching/storing estimated progression value progress has changed.

progress value is between 0 and 100.

reportError()

void QgsExternalStorageContent::reportError ( const QString &  errorMsg )

protected

Update content according to given errorMsg error message Inherited classes should call this method whenever they meet an error.

Definition at line 18 of file qgsexternalstorage.cpp.

setStatus()

void QgsExternalStorageContent::setStatus ( Qgis::ContentStatus  status )

protected

Sets the external storage status.

Definition at line 25 of file qgsexternalstorage.cpp.

status()

Qgis::ContentStatus QgsExternalStorageContent::status

(

)

const

Returns content status.

Definition at line 30 of file qgsexternalstorage.cpp.

Member Data Documentation

mErrorString

QString QgsExternalStorageContent::mErrorString

protected

Definition at line 165 of file qgsexternalstorage.h.

---

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

• /home/fischer/src/qgis-3.38/src/core/externalstorage/qgsexternalstorage.h
• /home/fischer/src/qgis-3.38/src/core/externalstorage/qgsexternalstorage.cpp