QGIS API Documentation  3.4.3-Madeira (2f64a3c)
Public Types | Public Slots | Signals | Public Member Functions | List of all members
QgsFetchedContent Class Reference

FetchedContent holds useful information about a network content being fetched. More...

#include <qgsnetworkcontentfetcherregistry.h>

Inheritance diagram for QgsFetchedContent:
Inheritance graph
[legend]

Public Types

enum  ContentStatus { NotStarted, Downloading, Finished, Failed }
 Status of fetched content. More...
 

Public Slots

void cancel ()
 Cancel the download operation. More...
 
void download (bool redownload=false)
 Start the download. More...
 

Signals

void fetched ()
 Emitted when the file is fetched and accessible. More...
 

Public Member Functions

 QgsFetchedContent (const QString &url, QTemporaryFile *file=nullptr, ContentStatus status=NotStarted)
 Constructs a FetchedContent with pointer to the downloaded file and status of the download. More...
 
 ~QgsFetchedContent () override
 
QNetworkReply::NetworkError error () const
 Returns the potential error of the download. More...
 
QFile * file () const
 Returns a pointer to the local file, a null pointer if the file is not accessible yet. More...
 
const QString filePath () const
 Returns the path to the local file, an empty string if the file is not accessible yet. More...
 
ContentStatus status () const
 Returns the status of the download. More...
 

Detailed Description

FetchedContent holds useful information about a network content being fetched.

See also
QgsNetworkContentFetcherRegistry
Since
QGIS 3.2

Definition at line 43 of file qgsnetworkcontentfetcherregistry.h.

Member Enumeration Documentation

◆ ContentStatus

Status of fetched content.

Enumerator
NotStarted 

No download started for such URL.

Downloading 

Currently downloading.

Finished 

Download finished and successful.

Failed 

Download failed.

Definition at line 48 of file qgsnetworkcontentfetcherregistry.h.

Constructor & Destructor Documentation

◆ QgsFetchedContent()

QgsFetchedContent::QgsFetchedContent ( const QString &  url,
QTemporaryFile *  file = nullptr,
ContentStatus  status = NotStarted 
)
inlineexplicit

Constructs a FetchedContent with pointer to the downloaded file and status of the download.

Definition at line 57 of file qgsnetworkcontentfetcherregistry.h.

◆ ~QgsFetchedContent()

QgsFetchedContent::~QgsFetchedContent ( )
inlineoverride

Definition at line 63 of file qgsnetworkcontentfetcherregistry.h.

Member Function Documentation

◆ cancel

void QgsFetchedContent::cancel ( )
slot

Cancel the download operation.

Definition at line 137 of file qgsnetworkcontentfetcherregistry.cpp.

◆ download

void QgsFetchedContent::download ( bool  redownload = false)
slot

Start the download.

Parameters
redownloadif set to true, it will restart any achieved or pending download.

Definition at line 113 of file qgsnetworkcontentfetcherregistry.cpp.

◆ error()

QNetworkReply::NetworkError QgsFetchedContent::error ( ) const
inline

Returns the potential error of the download.

Definition at line 83 of file qgsnetworkcontentfetcherregistry.h.

◆ fetched

void QgsFetchedContent::fetched ( )
signal

Emitted when the file is fetched and accessible.

◆ file()

QFile* QgsFetchedContent::file ( ) const
inline

Returns a pointer to the local file, a null pointer if the file is not accessible yet.

Definition at line 73 of file qgsnetworkcontentfetcherregistry.h.

◆ filePath()

const QString QgsFetchedContent::filePath ( ) const
inline

Returns the path to the local file, an empty string if the file is not accessible yet.

Definition at line 77 of file qgsnetworkcontentfetcherregistry.h.

◆ status()

ContentStatus QgsFetchedContent::status ( ) const
inline

Returns the status of the download.

Definition at line 80 of file qgsnetworkcontentfetcherregistry.h.


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