diff options
Diffstat (limited to 'src/xml/doc/snippets')
| -rw-r--r-- | src/xml/doc/snippets/CMakeLists.txt | 2 | ||||
| -rw-r--r-- | src/xml/doc/snippets/code/doc_src_qtxml.qdoc | 2 | ||||
| -rw-r--r-- | src/xml/doc/snippets/code/src_xml_dom_qdom.cpp | 11 | ||||
| -rw-r--r-- | src/xml/doc/snippets/code/src_xml_sax_qxml.cpp | 6 | ||||
| -rw-r--r-- | src/xml/doc/snippets/rsslisting/handler.cpp | 145 | ||||
| -rw-r--r-- | src/xml/doc/snippets/rsslisting/listing.cpp | 214 |
6 files changed, 2 insertions, 378 deletions
diff --git a/src/xml/doc/snippets/CMakeLists.txt b/src/xml/doc/snippets/CMakeLists.txt index 43f53ce03c..57b98440d4 100644 --- a/src/xml/doc/snippets/CMakeLists.txt +++ b/src/xml/doc/snippets/CMakeLists.txt @@ -1,5 +1,5 @@ # Copyright (C) 2022 The Qt Company Ltd. -# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GPL-3.0-only WITH Qt-GPL-exception-1.0 +# SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause #! [cmake_use] find_package(Qt6 REQUIRED COMPONENTS Xml) diff --git a/src/xml/doc/snippets/code/doc_src_qtxml.qdoc b/src/xml/doc/snippets/code/doc_src_qtxml.qdoc index 31d260a7ca..b1f24df7e1 100644 --- a/src/xml/doc/snippets/code/doc_src_qtxml.qdoc +++ b/src/xml/doc/snippets/code/doc_src_qtxml.qdoc @@ -1,5 +1,5 @@ // Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause +// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR GFDL-1.3-no-invariants-only //! [3] <quote>A quotation.</quote> diff --git a/src/xml/doc/snippets/code/src_xml_dom_qdom.cpp b/src/xml/doc/snippets/code/src_xml_dom_qdom.cpp index a97a5afcf6..7c7a59745b 100644 --- a/src/xml/doc/snippets/code/src_xml_dom_qdom.cpp +++ b/src/xml/doc/snippets/code/src_xml_dom_qdom.cpp @@ -89,17 +89,6 @@ for(QDomNode n = element.firstChild(); !n.isNull(); n = n.nextSibling()) //! [10] } -void FirstElement() -{ -//! [11] -QDomDocument doc; -QDomElement root = doc.firstChildElement("database"); -QDomElement elt = root.firstChildElement("entry"); -for (; !elt.isNull(); elt = elt.nextSiblingElement("entry")) { - // ... -} -//! [11] -} void FileContent() { diff --git a/src/xml/doc/snippets/code/src_xml_sax_qxml.cpp b/src/xml/doc/snippets/code/src_xml_sax_qxml.cpp deleted file mode 100644 index f64a6b8b1b..0000000000 --- a/src/xml/doc/snippets/code/src_xml_sax_qxml.cpp +++ /dev/null @@ -1,6 +0,0 @@ -// Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -//! [0] -xmlReader.setFeature("http://xml.org/sax/features/namespace-prefixes", true); -//! [0] diff --git a/src/xml/doc/snippets/rsslisting/handler.cpp b/src/xml/doc/snippets/rsslisting/handler.cpp deleted file mode 100644 index ef2df04653..0000000000 --- a/src/xml/doc/snippets/rsslisting/handler.cpp +++ /dev/null @@ -1,145 +0,0 @@ -// Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -/* -handler.cpp - -Provides a handler for processing XML elements found by the reader. - -The handler looks for <title> and <link> elements within <item> elements, -and records the text found within them. Link information stored within -rdf:about attributes of <item> elements is also recorded when it is -available. - -For each item found, a signal is emitted which specifies its title and -link information. This may be used by user interfaces for the purpose of -displaying items as they are read. -*/ - -#include <QtGui> - -#include "handler.h" - -/* - Reset the state of the handler to ensure that new documents are - read correctly. - - We return true to indicate that parsing should continue. -*/ - -bool Handler::startDocument() -{ - inItem = false; - inTitle = false; - inLink = false; - - return true; -} - -/* - Process each starting element in the XML document. - - Nested item, title, or link elements are not allowed, so we return false - if we encounter any of these. We also prohibit multiple definitions of - title strings. - - Link destinations are read by this function if they are specified as - attributes in item elements. - - For all cases not explicitly checked for, we return true to indicate that - the element is acceptable, and that parsing should continue. By doing - this, we can ignore elements in which we are not interested. -*/ - -bool Handler::startElement(const QString &, const QString &, - const QString & qName, const QXmlAttributes &attr) -{ - if (qName == "item") { - - if (inItem) - return false; - else { - inItem = true; - linkString = attr.value("rdf:about"); - } - } - else if (qName == "title") { - - if (inTitle) - return false; - else if (!titleString.isEmpty()) - return false; - else if (inItem) - inTitle = true; - } - else if (qName == "link") { - - if (inLink) - return false; - else if (inItem) - inLink = true; - } - - return true; -} - -/* - Process each ending element in the XML document. - - For recognized elements, we reset flags to ensure that we can read new - instances of these elements. If we have read an item element, emit a - signal to indicate that a new item is available for display. - - We return true to indicate that parsing should continue. -*/ - -bool Handler::endElement(const QString &, const QString &, - const QString & qName) -{ - if (qName == "title" && inTitle) - inTitle = false; - else if (qName == "link" && inLink) - inLink = false; - else if (qName == "item") { - if (!titleString.isEmpty() && !linkString.isEmpty()) - emit newItem(titleString, linkString); - inItem = false; - titleString = ""; - linkString = ""; - } - - return true; -} - -/* - Collect characters when reading the contents of title or link elements - when they occur within an item element. - - We return true to indicate that parsing should continue. -*/ - -bool Handler::characters (const QString &chars) -{ - if (inTitle) - titleString += chars; - else if (inLink) - linkString += chars; - - return true; -} - -/* - Report a fatal parsing error, and return false to indicate to the reader - that parsing should stop. -*/ - -//! [0] -bool Handler::fatalError (const QXmlParseException & exception) -{ - qWarning() << "Fatal error on line" << exception.lineNumber() - << ", column" << exception.columnNumber() << ':' - << exception.message(); - - return false; -} -//! [0] diff --git a/src/xml/doc/snippets/rsslisting/listing.cpp b/src/xml/doc/snippets/rsslisting/listing.cpp deleted file mode 100644 index d7fd28d56c..0000000000 --- a/src/xml/doc/snippets/rsslisting/listing.cpp +++ /dev/null @@ -1,214 +0,0 @@ -// Copyright (C) 2016 The Qt Company Ltd. -// SPDX-License-Identifier: LicenseRef-Qt-Commercial OR BSD-3-Clause - -/* -rsslisting.cpp - -Provides a widget for displaying news items from RDF news sources. -RDF is an XML-based format for storing items of information (see -http://www.w3.org/RDF/ for details). - -The widget itself provides a simple user interface for specifying -the URL of a news source, and controlling the downloading of news. - -The widget downloads and parses the XML asynchronously, feeding the -data to an XML reader in pieces. This allows the user to interrupt -its operation, and also allows very large data sources to be read. -*/ - - -#include <QtCore> -#include <QtGui> -#include <QtNetwork> -#include <QtXml> - -#include "rsslisting.h" - - -/* - Constructs an RSSListing widget with a simple user interface, and sets - up the XML reader to use a custom handler class. - - The user interface consists of a line edit, two push buttons, and a - list view widget. The line edit is used for entering the URLs of news - sources; the push buttons start and abort the process of reading the - news. -*/ - -RSSListing::RSSListing(QWidget *parent) - : QWidget(parent) -{ - lineEdit = new QLineEdit(this); - - fetchButton = new QPushButton(tr("Fetch"), this); - abortButton = new QPushButton(tr("Abort"), this); - abortButton->setEnabled(false); - - treeWidget = new QTreeWidget(this); - QStringList headerLabels; - headerLabels << tr("Title") << tr("Link"); - treeWidget->setHeaderLabels(headerLabels); - - handler = 0; - - connect(&http, SIGNAL(readyRead(QHttpResponseHeader)), - this, SLOT(readData(QHttpResponseHeader))); - - connect(&http, SIGNAL(requestFinished(int,bool)), - this, SLOT(finished(int,bool))); - - connect(lineEdit, SIGNAL(returnPressed()), this, SLOT(fetch())); - connect(fetchButton, SIGNAL(clicked()), this, SLOT(fetch())); - connect(abortButton, SIGNAL(clicked()), &http, SLOT(abort())); - - QVBoxLayout *layout = new QVBoxLayout(this); - - QHBoxLayout *hboxLayout = new QHBoxLayout; - - hboxLayout->addWidget(lineEdit); - hboxLayout->addWidget(fetchButton); - hboxLayout->addWidget(abortButton); - - layout->addLayout(hboxLayout); - layout->addWidget(treeWidget); - - setWindowTitle(tr("RSS listing example")); -} - -/* - Starts fetching data from a news source specified in the line - edit widget. - - The line edit is made read only to prevent the user from modifying its - contents during the fetch; this is only for cosmetic purposes. - The fetch button is disabled, and the abort button is enabled to allow - the user to interrupt processing. The list view is cleared, and we - define the last list view item to be 0, meaning that there are no - existing items in the list. - - We reset the flag used to determine whether parsing should begin again - or continue. A new handler is created, if required, and made available - to the reader. - - The HTTP handler is supplied with the raw contents of the line edit and - a fetch is initiated. We keep the ID value returned by the HTTP handler - for future reference. -*/ - -void RSSListing::fetch() -{ - lineEdit->setReadOnly(true); - fetchButton->setEnabled(false); - abortButton->setEnabled(true); - treeWidget->clear(); - - lastItemCreated = 0; - - newInformation = true; - - if (handler != 0) - delete handler; - handler = new Handler; - -//! [0] - xmlReader.setContentHandler(handler); - xmlReader.setErrorHandler(handler); -//! [0] - - connect(handler, SIGNAL(newItem(QString&,QString&)), - this, SLOT(addItem(QString&,QString&))); - - QUrl url(lineEdit->text()); - - http.setHost(url.host()); - connectionId = http.get(url.path()); -} - -/* - Reads data received from the RDF source. - - We read all the available data, and pass it to the XML - input source. The first time we receive new information, - the reader is set up for a new incremental parse; - we continue parsing using a different function on - subsequent calls involving the same data source. - - If parsing fails for any reason, we abort the fetch. -*/ - -//! [1] -void RSSListing::readData(const QHttpResponseHeader &resp) -{ - bool ok; - - if (resp.statusCode() != 200) - http.abort(); - else { - xmlInput.setData(http.readAll()); - - if (newInformation) { - ok = xmlReader.parse(&xmlInput, true); - newInformation = false; - } - else - ok = xmlReader.parseContinue(); - - if (!ok) - http.abort(); - } -} -//! [1] - -/* - Finishes processing an HTTP request. - - The default behavior is to keep the text edit read only. - - If an error has occurred, the user interface is made available - to the user for further input, allowing a new fetch to be - started. - - If the HTTP get request has finished, we perform a final - parsing operation on the data returned to ensure that it was - well-formed. Whether this is successful or not, we make the - user interface available to the user for further input. -*/ - -void RSSListing::finished(int id, bool error) -{ - if (error) { - qWarning("Received error during HTTP fetch."); - lineEdit->setReadOnly(false); - abortButton->setEnabled(false); - fetchButton->setEnabled(true); - } - else if (id == connectionId) { - - bool ok = xmlReader.parseContinue(); - if (!ok) - qWarning("Parse error at the end of input."); - - lineEdit->setReadOnly(false); - abortButton->setEnabled(false); - fetchButton->setEnabled(true); - } -} - -/* - Adds an item to the list view as it is reported by the handler. - - We keep a record of the last item created to ensure that the - items are created in sequence. -*/ - -void RSSListing::addItem(QString &title, QString &link) -{ - QTreeWidgetItem *item; - - item = new QTreeWidgetItem(treeWidget, lastItemCreated); - item->setText(0, title); - item->setText(1, link); - - lastItemCreated = item; -} - |