QGIS/python/core/auto_generated/qgsnetworkcontentfetcher.sip.in

98 lines
2.5 KiB
Plaintext
Raw Normal View History

2017-05-14 09:48:41 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsnetworkcontentfetcher.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/
class QgsNetworkContentFetcher : QObject
{
2017-05-14 09:48:41 +02:00
%Docstring
HTTP network content fetcher. A simple method for fetching remote HTTP content
2017-05-14 09:48:41 +02:00
and converting the content to standard formats. Url redirects are automatically
handled.
2017-12-15 10:36:55 -04:00
.. seealso:: :py:class:`QgsNetworkContentFetcherTask`
2018-05-28 11:31:08 -04:00
.. versionadded:: 2.5
%End
2017-05-14 09:48:41 +02:00
%TypeHeaderCode
#include "qgsnetworkcontentfetcher.h"
%End
public:
QgsNetworkContentFetcher();
%Docstring
2017-12-15 10:36:55 -04:00
Constructor for QgsNetworkContentFetcher.
%End
~QgsNetworkContentFetcher();
void fetchContent( const QUrl &url );
2017-05-14 09:48:41 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Fetches content from a remote URL and handles redirects. The finished()
signal will be emitted when content has been fetched.
2017-12-15 21:36:08 -04:00
2017-12-15 10:36:55 -04:00
:param url: URL to fetch
%End
void fetchContent( const QNetworkRequest &request );
%Docstring
Fetches content using a network ``request`` and handles redirects. The finished()
signal will be emitted when content has been fetched.
.. versionadded:: 3.2
2017-05-14 09:48:41 +02:00
%End
QNetworkReply *reply();
2017-05-14 09:48:41 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Returns a reference to the network reply
:return: QNetworkReply for fetched URL content
2017-05-14 09:48:41 +02:00
%End
QString contentAsString() const;
2017-05-14 09:48:41 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Returns the fetched content as a string
:return: string containing network content
%End
void cancel();
%Docstring
Cancels any ongoing request.
.. versionadded:: 3.2
2017-05-14 09:48:41 +02:00
%End
signals:
void finished();
2017-05-14 09:48:41 +02:00
%Docstring
2017-12-15 10:36:55 -04:00
Emitted when content has loaded
%End
void downloadProgress( qint64 bytesReceived, qint64 bytesTotal );
%Docstring
Emitted when data is received.
.. versionadded:: 3.2
2017-05-14 09:48:41 +02:00
%End
};
2017-05-14 09:48:41 +02:00
/************************************************************************
* This file has been generated automatically from *
* *
* src/core/qgsnetworkcontentfetcher.h *
* *
* Do not edit manually ! Edit header and run scripts/sipify.pl again *
************************************************************************/