summaryrefslogtreecommitdiffstats
path: root/src/webenginewidgets/api/qwebengineurlrequestjob.cpp
diff options
context:
space:
mode:
Diffstat (limited to 'src/webenginewidgets/api/qwebengineurlrequestjob.cpp')
-rw-r--r--src/webenginewidgets/api/qwebengineurlrequestjob.cpp30
1 files changed, 30 insertions, 0 deletions
diff --git a/src/webenginewidgets/api/qwebengineurlrequestjob.cpp b/src/webenginewidgets/api/qwebengineurlrequestjob.cpp
index cb8b200a2..323cdcc72 100644
--- a/src/webenginewidgets/api/qwebengineurlrequestjob.cpp
+++ b/src/webenginewidgets/api/qwebengineurlrequestjob.cpp
@@ -42,21 +42,51 @@
QT_BEGIN_NAMESPACE
+/*!
+ \class QWebEngineUrlRequestJob
+ \brief The QWebEngineUrlRequestJob class represents a custom URL request.
+ \since 5.5
+ \internal
+
+ A QWebEngineUrlRequestJob is given to QWebEngineUrlSchemeHandler::requestStarted() and must
+ be handled by the derived implementations of class.
+
+ A job can be handled by calling setReply().
+
+ The class is owned by QtWebEngine and does not need to be deleted. Note QtWebEngine may delete
+ the job when it is no longer needed, so the signal QObject::destroyed() must be monitored if
+ a pointer to the object is stored.
+
+ \inmodule QtWebEngineWidgets
+*/
+
+/*!
+ \internal
+ */
QWebEngineUrlRequestJob::QWebEngineUrlRequestJob(QtWebEngineCore::URLRequestCustomJobDelegate * p)
: QObject(p) // owned by the jobdelegate and deleted when the job is done
, d_ptr(p)
{
}
+/*!
+ \internal
+ */
QWebEngineUrlRequestJob::~QWebEngineUrlRequestJob()
{
}
+/*!
+ Returns the url requested.
+ */
QUrl QWebEngineUrlRequestJob::requestUrl() const
{
return d_ptr->url();
}
+/*!
+ Sets the reply for the request to \a device with the mime-type \a contentType.
+ */
void QWebEngineUrlRequestJob::setReply(const QByteArray &contentType, QIODevice *device)
{
d_ptr->setReply(contentType, device);