AlkDownloadEngine Class Reference

#include <alkdownloadengine.h>

Inheritance diagram for AlkDownloadEngine:

Public Types
enum	Type {   QtEngine , WebKitEngine , WebEngine , DefaultEngine ,   JavaScriptEngine , JavaScriptEngineCSS }
Public Types inherited from QObject
typedef	QObjectList

Signals
void	error (const QUrl &url, const QString &message)
void	finished (const QUrl &url, const QString &data)
void	finishedPage (const QUrl &url, AlkWebPage *page)
void	redirected (const QUrl &url, const QUrl &newUrl)
void	started (const QUrl &url)
void	timeout (const QUrl &url)

Public Member Functions
	AlkDownloadEngine (QObject *parent=nullptr)
	~AlkDownloadEngine ()
bool	downloadUrl (const QUrl &url, Type type)
void	setAcceptedLanguage (const QString &language)
void	setTimeout (int timeout=-1)
void	setWebPage (AlkWebPage *webPage)
int	timeout ()
Public Member Functions inherited from QObject
	QObject (QObject *parent)
QBindable< QString >	bindableObjectName ()
bool	blockSignals (bool block)
const QObjectList &	children () const const
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const char *method, Qt::ConnectionType type) const const
void	deleteLater ()
void	destroyed (QObject *obj)
bool	disconnect (const char *signal, const QObject *receiver, const char *method) const const
bool	disconnect (const QObject *receiver, const char *method) const const
void	dumpObjectInfo () const const
void	dumpObjectTree () const const
QList< QByteArray >	dynamicPropertyNames () const const
virtual bool	event (QEvent *e)
virtual bool	eventFilter (QObject *watched, QEvent *event)
T	findChild (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QRegularExpression &re, Qt::FindChildOptions options) const const
QList< T >	findChildren (const QString &name, Qt::FindChildOptions options) const const
QList< T >	findChildren (Qt::FindChildOptions options) const const
bool	inherits (const char *className) const const
void	installEventFilter (QObject *filterObj)
bool	isQuickItemType () const const
bool	isWidgetType () const const
bool	isWindowType () const const
void	killTimer (int id)
virtual const QMetaObject *	metaObject () const const
void	moveToThread (QThread *targetThread)
QString	objectName () const const
void	objectNameChanged (const QString &objectName)
QObject *	parent () const const
QVariant	property (const char *name) const const
	Q_CLASSINFO (Name, Value)
	Q_EMIT Q_EMIT
	Q_ENUM (...)
	Q_ENUM_NS (...)
	Q_ENUMS (...)
	Q_FLAG (...)
	Q_FLAG_NS (...)
	Q_FLAGS (...)
	Q_GADGET Q_GADGET
	Q_GADGET_EXPORT (EXPORT_MACRO)
	Q_INTERFACES (...)
	Q_INVOKABLE Q_INVOKABLE
	Q_MOC_INCLUDE Q_MOC_INCLUDE
	Q_NAMESPACE Q_NAMESPACE
	Q_NAMESPACE_EXPORT (EXPORT_MACRO)
	Q_OBJECT Q_OBJECT
	Q_PROPERTY (...)
	Q_REVISION Q_REVISION
	Q_SET_OBJECT_NAME (Object)
	Q_SIGNAL Q_SIGNAL
	Q_SIGNALS Q_SIGNALS
	Q_SLOT Q_SLOT
	Q_SLOTS Q_SLOTS
T	qobject_cast (const QObject *object)
T	qobject_cast (QObject *object)
	QT_NO_NARROWING_CONVERSIONS_IN_CONNECT QT_NO_NARROWING_CONVERSIONS_IN_CONNECT
void	removeEventFilter (QObject *obj)
void	setObjectName (const QString &name)
void	setObjectName (QAnyStringView name)
void	setParent (QObject *parent)
bool	setProperty (const char *name, const QVariant &value)
bool	setProperty (const char *name, QVariant &&value)
bool	signalsBlocked () const const
int	startTimer (int interval, Qt::TimerType timerType)
int	startTimer (std::chrono::milliseconds interval, Qt::TimerType timerType)
QThread *	thread () const const

Additional Inherited Members
Properties inherited from QObject
	objectName
Static Public Member Functions inherited from QObject
QMetaObject::Connection	connect (const QObject *sender, const char *signal, const QObject *receiver, const char *method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, const QMetaMethod &signal, const QObject *receiver, const QMetaMethod &method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *context, Functor functor, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method, Qt::ConnectionType type)
QMetaObject::Connection	connect (const QObject *sender, PointerToMemberFunction signal, Functor functor)
bool	disconnect (const QMetaObject::Connection &connection)
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)
bool	disconnect (const QObject *sender, PointerToMemberFunction signal, const QObject *receiver, PointerToMemberFunction method)
QString	tr (const char *sourceText, const char *disambiguation, int n)
Protected Member Functions inherited from QObject
virtual void	childEvent (QChildEvent *event)
virtual void	connectNotify (const QMetaMethod &signal)
virtual void	customEvent (QEvent *event)
virtual void	disconnectNotify (const QMetaMethod &signal)
bool	isSignalConnected (const QMetaMethod &signal) const const
int	receivers (const char *signal) const const
QObject *	sender () const const
int	senderSignalIndex () const const
virtual void	timerEvent (QTimerEvent *event)

Detailed Description

The DownloadEngine class provides a general interface for the supported implementation for downloading page content.

Definition at line 24 of file alkdownloadengine.h.

Member Enumeration Documentation

Type

enum AlkDownloadEngine::Type

Enumerator
DefaultEngine	Use Qt network support.
JavaScriptEngine	Use an HTML engine with Javascript support.
JavaScriptEngineCSS	Use an HTML engine with Javascript support,. See also AlkDownloadEngine::finishedPage for details

Definition at line 28 of file alkdownloadengine.h.

Constructor & Destructor Documentation

AlkDownloadEngine()

AlkDownloadEngine::AlkDownloadEngine ( QObject * parent = nullptr )

explicit

Constructor.

Parameters

parent

Parent object

Definition at line 213 of file alkdownloadengine.cpp.

~AlkDownloadEngine()

AlkDownloadEngine::~AlkDownloadEngine

(

)

Destructor.

Definition at line 219 of file alkdownloadengine.cpp.

Member Function Documentation

downloadUrl()

bool AlkDownloadEngine::downloadUrl	(	const QUrl &	url,
		Type	type )

Download content from a URL using the engine specified by the type.

This method blocks until the download is complete. The status and result of the download is returned via the available signals.

Parameters

url	Url to download
type	Type of engine to use for downloading
timeout	Timeout for fetching the content [msec]

Returns

true - fetching succeded

false - fetching failed

Definition at line 239 of file alkdownloadengine.cpp.

error

void AlkDownloadEngine::error ( const QUrl & url, const QString & message )

signal

Emitted in case of of errors.

Parameters

url	The url from which the error has been recognzied
message	Error message

finished

void AlkDownloadEngine::finished ( const QUrl & url, const QString & data )

signal

Is emitted if the type parameter of AlkDownloadEngine::downloadUrl() is AlkDownloadEngine::DefaultEngine or AlkDownloadEngine::JavaScriptEngine.

Parameters

url	The url from which the data is returned
data	The returned data

finishedPage

void AlkDownloadEngine::finishedPage ( const QUrl & url, AlkWebPage * page )

signal

Is emitted if the type parameter of AlkDownloadEngine::downloadUrl() is JavaScriptEngineCSS.

Parameters

url	The url from which the data is returned
page	The page instance containing the returned data

redirected

void AlkDownloadEngine::redirected ( const QUrl & url, const QUrl & newUrl )

signal

Is emitted if the url has been redirected.

Parameters

url	The associated url
newurl	The redirected url

setAcceptedLanguage()

void AlkDownloadEngine::setAcceptedLanguage

(

const QString &

language

)

Set specific language to be accepted for the download.

The supported format of the specified language is described at https://www.rfc-editor.org/rfc/rfc9110.html#field.accept-language.

Parameters

language

String with the accepted language

Definition at line 263 of file alkdownloadengine.cpp.

setTimeout()

void AlkDownloadEngine::setTimeout

(

int

timeout = -1

)

Set timeout for download operation A timeout value of -1 disables timeout support.

Parameters

timeout

Timeout in milliseconds

Definition at line 229 of file alkdownloadengine.cpp.

setWebPage()

void AlkDownloadEngine::setWebPage

(

AlkWebPage *

webPage

)

Specifies a custom instance of the HTML engine that is used to download content.

If this method is not called, an internal instance is used.

Parameters

webPage

Instance of HTML engine

Definition at line 224 of file alkdownloadengine.cpp.

started

void AlkDownloadEngine::started ( const QUrl & url )

signal

Is emitted if the download has been started.

Parameters

url	The associated url

timeout() [1/2]

int AlkDownloadEngine::timeout

(

)

Return timeout for download operation.

Returns

timeout in milliseconds

Definition at line 234 of file alkdownloadengine.cpp.

timeout [2/2]

void AlkDownloadEngine::timeout ( const QUrl & url )

signal

Is emitted if the download request has been timed out.

Parameters

url	The url which has been timeout out

---

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

• alkdownloadengine.h
• alkdownloadengine.cpp