diff options
| -rw-r--r-- | examples/qml/CMakeLists.txt | 1 | ||||
| -rw-r--r-- | examples/qml/qml.pro | 3 | ||||
| -rw-r--r-- | examples/qml/xmlhttprequest/CMakeLists.txt | 45 | ||||
| -rw-r--r-- | examples/qml/xmlhttprequest/data.xml | 5 | ||||
| -rw-r--r-- | examples/qml/xmlhttprequest/doc/images/qml-xmlhttprequest-example.png | bin | 20934 -> 0 bytes | |||
| -rw-r--r-- | examples/qml/xmlhttprequest/doc/src/xmlhttprequest.qdoc | 20 | ||||
| -rw-r--r-- | examples/qml/xmlhttprequest/main.cpp | 26 | ||||
| -rw-r--r-- | examples/qml/xmlhttprequest/methods.js | 34 | ||||
| -rw-r--r-- | examples/qml/xmlhttprequest/xmlhttprequest.pro | 15 | ||||
| -rw-r--r-- | examples/qml/xmlhttprequest/xmlhttprequest.qml | 28 | ||||
| -rw-r--r-- | examples/qml/xmlhttprequest/xmlhttprequest.qmlproject | 16 | ||||
| -rw-r--r-- | examples/qml/xmlhttprequest/xmlhttprequest.qrc | 7 | ||||
| -rw-r--r-- | src/qml/doc/snippets/qml/XHRForm.qml | 83 | ||||
| -rw-r--r-- | src/qml/doc/snippets/qml/xmlhttprequest.js | 25 | ||||
| -rw-r--r-- | src/qml/doc/src/javascript/qmlglobalobject.qdoc | 78 | ||||
| -rw-r--r-- | src/qml/doc/src/javascript/xmlhttprequest.qdoc | 285 |
16 files changed, 394 insertions, 277 deletions
diff --git a/examples/qml/CMakeLists.txt b/examples/qml/CMakeLists.txt index 0e255887d2..91fc57b8f1 100644 --- a/examples/qml/CMakeLists.txt +++ b/examples/qml/CMakeLists.txt @@ -6,7 +6,6 @@ add_subdirectory(tutorials) qt_internal_add_example(shell) if(TARGET Qt::Quick) qt_internal_add_example(qmlextensionplugins) - qt_internal_add_example(xmlhttprequest) if (TARGET Qt::lupdate) qt_internal_add_example(qml-i18n) endif() diff --git a/examples/qml/qml.pro b/examples/qml/qml.pro index ee7699fdc5..5a81c00212 100644 --- a/examples/qml/qml.pro +++ b/examples/qml/qml.pro @@ -3,8 +3,7 @@ QT_FOR_CONFIG += qml qtHaveModule(quick) { SUBDIRS += \ - qmlextensionplugins \ - xmlhttprequest + qmlextensionplugins } SUBDIRS += \ diff --git a/examples/qml/xmlhttprequest/CMakeLists.txt b/examples/qml/xmlhttprequest/CMakeLists.txt deleted file mode 100644 index 8c36cf54d4..0000000000 --- a/examples/qml/xmlhttprequest/CMakeLists.txt +++ /dev/null @@ -1,45 +0,0 @@ -# Copyright (C) 2022 The Qt Company Ltd. -# SPDX-License-Identifier: BSD-3-Clause - -cmake_minimum_required(VERSION 3.16) -project(xmlhttprequest LANGUAGES CXX) - -set(CMAKE_AUTOMOC ON) - -if(NOT DEFINED INSTALL_EXAMPLESDIR) - set(INSTALL_EXAMPLESDIR "examples") -endif() - -set(INSTALL_EXAMPLEDIR "${INSTALL_EXAMPLESDIR}/qml/xmlhttprequest") - -find_package(Qt6 REQUIRED COMPONENTS Core Gui Qml Quick) - -qt_standard_project_setup(REQUIRES 6.5) - -qt_add_executable(xmlhttprequestexample - WIN32 - MACOSX_BUNDLE - main.cpp -) - -qt_add_qml_module(xmlhttprequestexample - URI xmlhttprequest - QML_FILES - "methods.js" - "xmlhttprequest.qml" - RESOURCES - data.xml -) - -target_link_libraries(xmlhttprequestexample PUBLIC - Qt::Core - Qt::Gui - Qt::Qml - Qt::Quick -) - -install(TARGETS xmlhttprequestexample - RUNTIME DESTINATION "${INSTALL_EXAMPLEDIR}" - BUNDLE DESTINATION "${INSTALL_EXAMPLEDIR}" - LIBRARY DESTINATION "${INSTALL_EXAMPLEDIR}" -) diff --git a/examples/qml/xmlhttprequest/data.xml b/examples/qml/xmlhttprequest/data.xml deleted file mode 100644 index 8b7f1e116d..0000000000 --- a/examples/qml/xmlhttprequest/data.xml +++ /dev/null @@ -1,5 +0,0 @@ -<data> - <element1 /> - <element2 /> -</data> - diff --git a/examples/qml/xmlhttprequest/doc/images/qml-xmlhttprequest-example.png b/examples/qml/xmlhttprequest/doc/images/qml-xmlhttprequest-example.png Binary files differdeleted file mode 100644 index f585613427..0000000000 --- a/examples/qml/xmlhttprequest/doc/images/qml-xmlhttprequest-example.png +++ /dev/null diff --git a/examples/qml/xmlhttprequest/doc/src/xmlhttprequest.qdoc b/examples/qml/xmlhttprequest/doc/src/xmlhttprequest.qdoc deleted file mode 100644 index fc6ca600cd..0000000000 --- a/examples/qml/xmlhttprequest/doc/src/xmlhttprequest.qdoc +++ /dev/null @@ -1,20 +0,0 @@ -// Copyright (C) 2017 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only -/*! - \title Qt Quick Examples - XMLHttpRequest - \example xmlhttprequest - \brief This is a collection of XMLHttpRequest examples. - \image qml-xmlhttprequest-example.png - - \e XMLHttpRequest contains a small QML example demonstrating \l{Qt QML}'s - XMLHttpRequest functionality. For more information, visit the section about - \l{QML Global Object#XMLHttpRequest}{XMLHttpRequest}. - - \include examples-run.qdocinc - - \section1 Get Data - - \e{Get data} uses the XMLHttpRequest API to fetch an XML document from a - server. It displays the header of the HTTP response and the body of the XML - document. -*/ diff --git a/examples/qml/xmlhttprequest/main.cpp b/examples/qml/xmlhttprequest/main.cpp deleted file mode 100644 index f76ca49de5..0000000000 --- a/examples/qml/xmlhttprequest/main.cpp +++ /dev/null @@ -1,26 +0,0 @@ -// Copyright (C) 2021 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -#include <QDir> -#include <QGuiApplication> -#include <QQmlFileSelector> -#include <QQuickView> - -int main(int argc, char *argv[]) -{ - QGuiApplication app(argc, argv); - app.setOrganizationName("QtProject"); - app.setOrganizationDomain("qt-project.org"); - app.setApplicationName(QFileInfo(app.applicationFilePath()).baseName()); - QQuickView view; - - qputenv("QML_XHR_ALLOW_FILE_READ", QByteArray("1")); - - view.connect(view.engine(), &QQmlEngine::quit, &app, &QCoreApplication::quit); - view.setSource(QUrl("qrc:/qt/qml/xmlhttprequest/xmlhttprequest.qml")); - if (view.status() == QQuickView::Error) - return -1; - view.setResizeMode(QQuickView::SizeRootObjectToView); - view.show(); - return app.exec(); -} diff --git a/examples/qml/xmlhttprequest/methods.js b/examples/qml/xmlhttprequest/methods.js deleted file mode 100644 index 12bde365b2..0000000000 --- a/examples/qml/xmlhttprequest/methods.js +++ /dev/null @@ -1,34 +0,0 @@ -// Copyright (C) 2017 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -function showRequestInfo(text) { - msg.text = msg.text + "\n" + text -} - -function makeRequest() -{ - - var doc = new XMLHttpRequest(); - msg.text = ""; - doc.onreadystatechange = function() { - if (doc.readyState == XMLHttpRequest.HEADERS_RECEIVED) { - showRequestInfo("Headers -->"); - showRequestInfo(doc.getAllResponseHeaders ()); - showRequestInfo("Last modified -->"); - showRequestInfo(doc.getResponseHeader ("Last-Modified")); - - } else if (doc.readyState == XMLHttpRequest.DONE) { - var a = doc.responseXML.documentElement; - for (var ii = 0; ii < a.childNodes.length; ++ii) { - showRequestInfo(a.childNodes[ii].nodeName); - } - showRequestInfo("Headers -->"); - showRequestInfo(doc.getAllResponseHeaders ()); - showRequestInfo("Last modified -->"); - showRequestInfo(doc.getResponseHeader ("Last-Modified")); - } - } - - doc.open("GET", "data.xml"); - doc.send(); -} diff --git a/examples/qml/xmlhttprequest/xmlhttprequest.pro b/examples/qml/xmlhttprequest/xmlhttprequest.pro deleted file mode 100644 index 6d572fff59..0000000000 --- a/examples/qml/xmlhttprequest/xmlhttprequest.pro +++ /dev/null @@ -1,15 +0,0 @@ -TEMPLATE = app - -QT += quick qml -SOURCES += main.cpp -RESOURCES += \ - xmlhttprequest.qrc - -EXAMPLE_FILES = \ - data.xml - -target.path = $$[QT_INSTALL_EXAMPLES]/qml/xmlhttprequest -INSTALLS += target - -DISTFILES += \ - methods.js diff --git a/examples/qml/xmlhttprequest/xmlhttprequest.qml b/examples/qml/xmlhttprequest/xmlhttprequest.qml deleted file mode 100644 index 434648c16f..0000000000 --- a/examples/qml/xmlhttprequest/xmlhttprequest.qml +++ /dev/null @@ -1,28 +0,0 @@ -// Copyright (C) 2021 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -import QtQuick -import QtQuick.Controls -import "methods.js" as Utils - - -Item { - height: 480 - width: 320 - - property alias msg: ttext - - Label { id: ttext; anchors.fill: parent; anchors.margins: 10 } - - Button { - id: button - anchors.horizontalCenter: parent.horizontalCenter; - anchors.bottom: parent.bottom - anchors.margins: 10 - antialiasing: true - - text: qsTr("Request data.xml") - - onClicked: Utils.makeRequest() - } -} diff --git a/examples/qml/xmlhttprequest/xmlhttprequest.qmlproject b/examples/qml/xmlhttprequest/xmlhttprequest.qmlproject deleted file mode 100644 index 088042a100..0000000000 --- a/examples/qml/xmlhttprequest/xmlhttprequest.qmlproject +++ /dev/null @@ -1,16 +0,0 @@ -import QmlProject 1.0 - -Project { - mainFile: "xmlhttprequest.qml" - /* Include .qml, .js, and image files from current directory and subdirectories */ - - QmlFiles { - directory: "." - } - JavaScriptFiles { - directory: "." - } - ImageFiles { - directory: "." - } -}
\ No newline at end of file diff --git a/examples/qml/xmlhttprequest/xmlhttprequest.qrc b/examples/qml/xmlhttprequest/xmlhttprequest.qrc deleted file mode 100644 index 39d2a62393..0000000000 --- a/examples/qml/xmlhttprequest/xmlhttprequest.qrc +++ /dev/null @@ -1,7 +0,0 @@ -<RCC> - <qresource prefix="/qt/qml/xmlhttprequest"> - <file>xmlhttprequest.qml</file> - <file>methods.js</file> - <file>data.xml</file> - </qresource> -</RCC> diff --git a/src/qml/doc/snippets/qml/XHRForm.qml b/src/qml/doc/snippets/qml/XHRForm.qml new file mode 100644 index 0000000000..90c918ddbb --- /dev/null +++ b/src/qml/doc/snippets/qml/XHRForm.qml @@ -0,0 +1,83 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause + +//![0] +import QtQuick +import QtQuick.Layouts +import QtQuick.Controls +import "request.js" as XHR + +ApplicationWindow { + width: 640 + height: 640 + visible: true + + ColumnLayout { + anchors.fill: parent + + RowLayout { + Layout.fillWidth: true + + TextField { + id: urlTextField + text: "https://www.example.com/index.html" + Layout.fillWidth: true + } + Button { + text: qsTr("Send!") + onClicked: XHR.sendRequest(urlTextField.text, function(response) { + statusTextField.text = response.status; + let isPlainText = response.contentType.length === 0 + + contentTypeTextField.text = isPlainText ? "text" : response.contentType; + + if (isPlainText) + contentTextArea.text = response.content; + }); + } + } + + GridLayout { + columns: 2 + + Layout.fillWidth: true + + Label { + text: qsTr("Status code") + + Layout.fillWidth: true + } + Label { + text: qsTr("Response type") + + Layout.fillWidth: true + } + TextField { + id: statusTextField + + Layout.fillWidth: true + } + TextField { + id: contentTypeTextField + + Layout.fillWidth: true + } + } + Flickable { + clip: true + contentWidth: contentTextArea.width + contentHeight: contentTextArea.height + Text { + id: contentTextArea + } + + Layout.fillWidth: true + Layout.fillHeight: true + ScrollBar.vertical: ScrollBar {} + ScrollBar.horizontal: ScrollBar {} + } + } +} + +//![0] + diff --git a/src/qml/doc/snippets/qml/xmlhttprequest.js b/src/qml/doc/snippets/qml/xmlhttprequest.js new file mode 100644 index 0000000000..f395a15d8d --- /dev/null +++ b/src/qml/doc/snippets/qml/xmlhttprequest.js @@ -0,0 +1,25 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause + +//![0] +function sendRequest(url, callback) +{ + let request = new XMLHttpRequest(); + + request.onreadystatechange = function() { + if (request.readyState === XMLHttpRequest.DONE) { + let response = { + status : request.status, + headers : request.getAllResponseHeaders(), + contentType : request.responseType, + content : request.response + }; + + callback(response); + } + } + + request.open("GET", url); + request.send(); +} +//![0] diff --git a/src/qml/doc/src/javascript/qmlglobalobject.qdoc b/src/qml/doc/src/javascript/qmlglobalobject.qdoc index 0857cabbdc..91cd73d5c3 100644 --- a/src/qml/doc/src/javascript/qmlglobalobject.qdoc +++ b/src/qml/doc/src/javascript/qmlglobalobject.qdoc @@ -25,82 +25,4 @@ additional imports: the global object of a \l QQmlEngine. For more information about this, see \l {JavaScript Environment Restrictions}. -\target XMLHttpRequest -\section1 XMLHttpRequest - -The XMLHttpRequest object, which can be used to asynchronously obtain -data from over a network. - -The XMLHttpRequest API implements the same \l {http://www.w3.org/TR/XMLHttpRequest/}{W3C standard} -as many popular web browsers with following exceptions: -\list -\li QML's XMLHttpRequest does not enforce the same origin policy. -\endlist - -Additionally, the \c responseXML XML DOM tree currently supported by QML is a reduced subset -of the \l {http://www.w3.org/TR/DOM-Level-3-Core/}{DOM Level 3 Core} API supported in a web -browser. The following objects and properties are supported by the QML implementation: - -\table -\header -\li \b {Node} -\li \b {Document} -\li \b {Element} -\li \b {Attr} -\li \b {CharacterData} -\li \b {Text} - -\row -\li -\list -\li nodeName -\li nodeValue -\li nodeType -\li parentNode -\li childNodes -\li firstChild -\li lastChild -\li previousSibling -\li nextSibling -\li attributes -\endlist - -\li -\list -\li xmlVersion -\li xmlEncoding -\li xmlStandalone -\li documentElement -\endlist - -\li -\list -\li tagName -\endlist - -\li -\list -\li name -\li value -\li ownerElement -\endlist - -\li -\list -\li data -\li length -\endlist - -\li -\list -\li isElementContentWhitespace -\li wholeText -\endlist - -\endtable - -The \l{Qt Quick Examples - XMLHttpRequest}{XMLHttpRequest example} demonstrates -how to use the XMLHttpRequest object to make a request and read the response -headers. - */ diff --git a/src/qml/doc/src/javascript/xmlhttprequest.qdoc b/src/qml/doc/src/javascript/xmlhttprequest.qdoc new file mode 100644 index 0000000000..edf09ae095 --- /dev/null +++ b/src/qml/doc/src/javascript/xmlhttprequest.qdoc @@ -0,0 +1,285 @@ +// Copyright (C) 2023 The Qt Company Ltd. +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only + +/*! + \qmltype XMLHttpRequest + \inqmlmodule QtQml + \brief Object for sending requests to a server + + The \c XMLHttpRequest object allows scripts to perform HTTP client functionality, + such as submitting form data or loading data asynchronously from a server. + + The \c XMLHttpRequest API is a partial implementation of the + \l {https://www.w3.org/TR/2014/WD-XMLHttpRequest-20140130/}{W3C XHR Level 1 standard} + with the following exception: + \list + \li It does not enforce the same origin policy. + \endlist + + \section1 Sending requests + + Use the following steps to send a request using the \c XMLHttpRequest API: + \list 1 + \li Create a \c XMLHttpRequest object. + \li Assign a callback function to the \l {XMLHttpRequest::onreadystatechange}{onreadystatechange} signal handler. + \li Call \l {XMLHttpRequest::open}{open()} with the appropriate HTTP method and URL to request. + \li Call \l {XMLHttpRequest::send}{send()} + \endlist + + The callback function handles the HTTP response for a request. + It's a good practice to check if the \l{XMLHttpRequest::readyState}{readyState} is \c DONE in the handler, + before you use one of the following methods to read the response: + \list + \li \l {XMLHttpRequest::response}{response} + \li \l {XMLHttpRequest::responseText}{responseText} + \li \l {XMLHttpRequest::responseXML}{responseXML} + \endlist + + The following example demonstrates how to send a request and read the response: + + \snippet qml/XHRForm.qml 0 + + The earlier snippet connects the button's clicked signal to an external \c sendRequest function. + A resource URL is passed as the first argument, and a callback function to handle UI updates is passed as the second. + The \c sendRequest function, which exists in an external \c request.js file, can be implemented like this: + + \snippet qml/xmlhttprequest.js 0 + + The earlier snippet follows the four simple steps mentioned at the beginning. + It instantiates the \c XMLHttpRequest object first, and assigns a callback function to handle the response. + It also calls \l {XMLHttpRequest::open}{open()} with an HTTP method and URL, before it sends the request to the server. + Notice that the second argument to \c sendRequest is called at the end of \l {XMLHttpRequest::onreadystatechange}{onreadystatechange}, + in order to handle UI updates based on the HTTP response. + + Set the \c QML_XHR_DUMP environment variable to \c 1 if you want to debug a request. + This will log the following information: + \list + \li Method type (GET or POST), URL, and body of sent requests. + \li URL and body of responses received. + \li Network error, if any. + \endlist + + \section1 Accessing local files + + By default, you cannot use the \c XMLHttpRequest object to read files from your local file system. + If you wish to use this feature to access local files, you can set the following environment variables to \c 1. + \list + \li QML_XHR_ALLOW_FILE_READ + \li QML_XHR_ALLOW_FILE_WRITE + \endlist + \warning Use this feature only if you know that the application runs trusted QML and JavaScript code. + + \section1 responseXML document + + The \c responseXML XML DOM tree currently supported by QML is a reduced subset of + the \l {http://www.w3.org/TR/DOM-Level-3-Core/}{DOM Level 3 Core} API supported in a web browser. + The following objects and properties are supported by the QML implementation: + + \table + \header + \li \b {Node} + \li \b {Document} + \li \b {Element} + \li \b {Attr} + \li \b {CharacterData} + \li \b {Text} + + \row + \li + \list + \li nodeName + \li nodeValue + \li nodeType + \li parentNode + \li childNodes + \li firstChild + \li lastChild + \li previousSibling + \li nextSibling + \li attributes + \endlist + + \li + \list + \li xmlVersion + \li xmlEncoding + \li xmlStandalone + \li documentElement + \endlist + + \li + \list + \li tagName + \endlist + + \li + \list + \li name + \li value + \li ownerElement + \endlist + + \li + \list + \li data + \li length + \endlist + + \li + \list + \li isElementContentWhitespace + \li wholeText + \endlist + + \endtable +*/ + +/*! + \qmlmethod void XMLHttpRequest::abort() + + Cancels the current request. + + It changes the \l {XMLHttpRequest::readyState}{readyState} property to be \c XMLHttpRequest.UNSENT and emits the \c readystatechange signal. +*/ + +/*! + \qmlmethod string XMLHttpRequest::getAllResponseHeaders() + + Returns a \c String of headers received from the last response. + + The following is an example response header: + \code + content-encoding: gzip + content-type: text/html; charset=UTF-8 + date: Mon, 06 Feb 2023 09:00:08 GMT + expires: Mon, 13 Feb 2023 09:00:08 GMT + last-modified: Thu, 17 Oct 2019 07:18:26 GMT + \endcode + + \sa {XMLHttpRequest::getResponseHeader}{getResponseHeader()} +*/ + +/*! + \qmlmethod string XMLHttpRequest::getResponseHeader(headerName) + + Returns either the \a headerName value from the last response, or an empty \c String, if the \a headerName is missing. + + \sa {XMLHttpRequest::getAllResponseHeaders}{getAllResponseHeaders()} +*/ + +/*! + \qmlmethod void XMLHttpRequest::open(method, url, async) + + Specify the HTTP \a method you want the request to use, as well as the \a url you wish to request. + You should make sure to always call this function before \l {XMLHttpRequest::send}{send()}. + An optional third parameter \a async can be used to decide whether the request should be asynchronous or not. + The default value is \c true. + + Emits the \c readystatechange signal, which calls the \l {XMLHttpRequest::onreadystatechange}{onreadystatechange} handler with + the \l {XMLHttpRequest::readyState}{readyState} property set to \c XMLHttpRequest.OPENED. +*/ + +/*! + \qmlmethod void XMLHttpRequest::send(data) + + Sends the request to the server. + You can use the optional argument \a data to add extra data to the body of the request. + This can be useful for POST requests, where you typically want the request to contain extra data. + + The \l {XMLHttpRequest::readyState}{readyState} property is updated once a response has been received from the server, + and while the response is being processed. It will first be set to \c HEADERS_RECEIVED, then to \c LOADING, + and finally \c DONE, once the response has been fully processed. + The \c readystatechange signal is emitted every time \l {XMLHttpRequest::readyState}{readyState} is updated. +*/ + +/*! + \qmlmethod void XMLHttpRequest::setRequestHeader(header, value) + + Adds a new header to the next request you wish to send. + This is a key-value pair, which has the name \a header and the corresponding \a value. +*/ + +/*! + \qmlproperty function XMLHttpRequest::onreadystatechange + + Choose a callback function you want to get invoked whenever the \l {XMLHttpRequest::readyState}{readyState} of the \c XMLHttpRequest object changes. + + \sa {XMLHttpRequest::readyState}{readyState} +*/ + +/*! + \qmlproperty enumeration XMLHttpRequest::readyState + \readonly + + Indicates the current state of the \c XMLHttpRequest object. + + The value can be one of the following: + \value XMLHttpRequest.UNSENT The request is not initialized, which is the state before calling \l {XMLHttpRequest::open}{open()}. + \value XMLHttpRequest.OPENED The request is initialized, meaning \l {XMLHttpRequest::open}{open()} was previously called, but no further progress. + \value XMLHttpRequest.HEADERS_RECEIVED Received a reply from the sever, but the request is not fully processed yet. + \value XMLHttpRequest.LOADING Downloading data from the server. + \value XMLHttpRequest.DONE Finished processing the request. + + \sa {XMLHttpRequest::onreadystatechange}{onreadystatechange} +*/ + +/*! + \qmlproperty string XMLHttpRequest::responseText + \readonly + + Returns a \c String containing the data received from the last response. + + \sa {XMLHttpRequest::responseXML}{responseXML} +*/ + +/*! + \qmlproperty var XMLHttpRequest::responseXML + \readonly + + Returns either a \c Document, or \c null, if the response content cannot be parsed as XML or HTML. + See the \l {responseXML document}{responseXML document} section for more information. + + \sa {XMLHttpRequest::responseText}{responseText} +*/ + +/*! + \qmlproperty var XMLHttpRequest::response + \readonly + + Returns either a \c String, an \c ArrayBuffer, or a \c Document, + depending on the \l {XMLHttpRequest::responseType}{responseType} of the last request. + + \sa {XMLHttpRequest::responseType}{responseType}, {XMLHttpRequest::responseText}{responseText}, {XMLHttpRequest::responseXML}{responseXML} +*/ + +/*! + \qmlproperty string XMLHttpRequest::responseType + + Returns a \c String describing the content type of the last response received. + \list + \li If the response type is "text" or an empty \c String, the response content is a UTF-16 encoded \c String. + \li If the response type is "arraybuffer", it means that the response content is an \c ArrayBuffer containing binary data. + \li If the response type is "json", the response content should be a JSON \c Document. + \li If the response type is "document", it means that the response content is an XML \c Document, which can be safely read with the \l {XMLHttpRequest::responseXML}{responseXML} property. + \endlist + + \sa {XMLHttpRequest::response}{response} +*/ + +/*! + \qmlproperty int XMLHttpRequest::status + \readonly + + Returns the status code for the last response received. + + \sa {XMLHttpRequest::statusText}{statusText} +*/ + +/*! + \qmlproperty string XMLHttpRequest::statusText + \readonly + + Returns a \c String that has the status message associated with the status code for the last response received. + + \sa {XMLHttpRequest::status}{status} +*/ |
