From 2c7d46727ed1de7c8233f0520cc40e9e6ce72fac Mon Sep 17 00:00:00 2001 From: Nico Vertriest Date: Wed, 1 Jul 2020 08:58:05 +0200 Subject: Doc: Make snippets XML compilable Task-number: QTBUG-84459 Change-Id: I143a8b8869f7cb8547f1898831d0d6e86b7ac35d Reviewed-by: Paul Wicking --- src/xml/doc/snippets/code/src_xml_dom_qdom.cpp | 117 ++++++++------------- .../doc/snippets/code/src_xml_dom_qdom_snippet.cpp | 102 ++++++++++++++++++ src/xml/doc/snippets/snippets.pro | 4 + 3 files changed, 150 insertions(+), 73 deletions(-) create mode 100644 src/xml/doc/snippets/code/src_xml_dom_qdom_snippet.cpp (limited to 'src/xml/doc/snippets') 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 f7d81f676f..cc5d7c0b13 100644 --- a/src/xml/doc/snippets/code/src_xml_dom_qdom.cpp +++ b/src/xml/doc/snippets/code/src_xml_dom_qdom.cpp @@ -47,99 +47,83 @@ ** $QT_END_LICENSE$ ** ****************************************************************************/ - +#include +#include +#include +#include +#include + +void NodeElements(); +void DomText(); +void FirstElement(); +void FileContent(); +void DocAppend(); +void XML_snippet_main(); + +using namespace std; //! [0] +void XML_snippet_main() +{ QDomDocument doc; QDomImplementation impl; - // This will create the element, but the resulting XML document will // be invalid, because '~' is not a valid character in a tag name. -impl.setInvalidDataPolicy(QDomImplementation::AcceptInvalidData); +impl.setInvalidDataPolicy(QDomImplementation::AcceptInvalidChars); QDomElement elt1 = doc.createElement("foo~bar"); // This will create an element with the tag name "foobar". -impl.setInvalidDataPolicy(QDomImplementation::DropInvalidData); +impl.setInvalidDataPolicy(QDomImplementation::DropInvalidChars); QDomElement elt2 = doc.createElement("foo~bar"); // This will create a null element. impl.setInvalidDataPolicy(QDomImplementation::ReturnNullNode); QDomElement elt3 = doc.createElement("foo~bar"); +} //! [0] - +void NodeElements() +{ //! [1] QDomDocument d; +QString someXML; + d.setContent(someXML); QDomNode n = d.firstChild(); while (!n.isNull()) { if (n.isElement()) { QDomElement e = n.toElement(); - cout << "Element name: " << e.tagName() << Qt::endl; + cout << "Element name: " << qPrintable(e.tagName()) << '\n'; break; } n = n.nextSibling(); } //! [1] - //! [2] QDomDocument document; QDomElement element1 = document.documentElement(); QDomElement element2 = element1; //! [2] - //! [3] QDomElement element3 = document.createElement("MyElement"); QDomElement element4 = document.createElement("MyElement"); //! [3] - -//! [4] - -

Heading

Hello you

- -//! [4] - - -//! [5] -

Heading

The text...

Next heading

-//! [5] - - -//! [6] -

Heading

The text...

Next heading

-//! [6] - - -//! [7] - -//! [7] - - //! [8] -QDomElement e = //... +QDomElement e; //... QDomAttr a = e.attributeNode("href"); -cout << a.value() << Qt::endl; // prints "http://qt-project.org" +cout << qPrintable(a.value()) << '\n'; // prints "http://qt-project.org" a.setValue("http://qt-project.org/doc"); // change the node's attribute QDomAttr a2 = e.attributeNode("href"); -cout << a2.value() << Qt::endl; // prints "http://qt-project.org/doc" +cout << qPrintable(a2.value()) << '\n'; // prints "http://qt-project.org/doc" //! [8] +} - -//! [9] -QDomElement e = //... -//... -QString s = e.text() -//! [9] - - +void DomText() +{ +QDomDocument doc; //! [10] QString text; QDomElement element = doc.documentElement(); @@ -151,37 +135,21 @@ for(QDomNode n = element.firstChild(); !n.isNull(); n = n.nextSibling()) } //! [10] - +} +void FirstElement() +{ //! [11] -QDomDocument doc = // ... +QDomDocument doc; QDomElement root = doc.firstChildElement("database"); QDomElement elt = root.firstChildElement("entry"); for (; !elt.isNull(); elt = elt.nextSiblingElement("entry")) { // ... } //! [11] +} - -//! [12] -

-//! [12] - - -//! [13] -

Hello Qt ]]>

-//! [13] - - -//! [14] -Hello Qt -//! [14] - - -//! [15] - -//! [15] - - +void FileContent() +{ //! [16] QDomDocument doc("mydocument"); QFile file("mydocument.xml"); @@ -201,7 +169,7 @@ QDomNode n = docElem.firstChild(); while(!n.isNull()) { QDomElement e = n.toElement(); // try to convert the node to an element. if(!e.isNull()) { - cout << qPrintable(e.tagName()) << Qt::endl; // the node really is an element. + cout << qPrintable(e.tagName()) << '\n'; // the node really is an element. } n = n.nextSibling(); } @@ -211,10 +179,12 @@ QDomElement elem = doc.createElement("img"); elem.setAttribute("src", "myimage.png"); docElem.appendChild(elem); //! [16] +} - +void DocAppend() +{ //! [17] -QDomDocument doc("MyML"); +QDomDocument doc; QDomElement root = doc.createElement("MyML"); doc.appendChild(root); @@ -226,3 +196,4 @@ tag.appendChild(t); QString xml = doc.toString(); //! [17] +} diff --git a/src/xml/doc/snippets/code/src_xml_dom_qdom_snippet.cpp b/src/xml/doc/snippets/code/src_xml_dom_qdom_snippet.cpp new file mode 100644 index 0000000000..233cdac8d7 --- /dev/null +++ b/src/xml/doc/snippets/code/src_xml_dom_qdom_snippet.cpp @@ -0,0 +1,102 @@ +/**************************************************************************** +** +** Copyright (C) 2020 The Qt Company Ltd. +** Contact: https://www.qt.io/licensing/ +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:BSD$ +** Commercial License Usage +** Licensees holding valid commercial Qt licenses may use this file in +** accordance with the commercial license agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and The Qt Company. For licensing terms +** and conditions see https://www.qt.io/terms-conditions. For further +** information use the contact form at https://www.qt.io/contact-us. +** +** BSD License Usage +** Alternatively, you may use this file under the terms of the BSD license +** as follows: +** +** "Redistribution and use in source and binary forms, with or without +** modification, are permitted provided that the following conditions are +** met: +** * Redistributions of source code must retain the above copyright +** notice, this list of conditions and the following disclaimer. +** * Redistributions in binary form must reproduce the above copyright +** notice, this list of conditions and the following disclaimer in +** the documentation and/or other materials provided with the +** distribution. +** * Neither the name of The Qt Company Ltd nor the names of its +** contributors may be used to endorse or promote products derived +** from this software without specific prior written permission. +** +** +** THIS SOFTWARE IS PROVIDED BY THE COPYRIGHT HOLDERS AND CONTRIBUTORS +** "AS IS" AND ANY EXPRESS OR IMPLIED WARRANTIES, INCLUDING, BUT NOT +** LIMITED TO, THE IMPLIED WARRANTIES OF MERCHANTABILITY AND FITNESS FOR +** A PARTICULAR PURPOSE ARE DISCLAIMED. IN NO EVENT SHALL THE COPYRIGHT +** OWNER OR CONTRIBUTORS BE LIABLE FOR ANY DIRECT, INDIRECT, INCIDENTAL, +** SPECIAL, EXEMPLARY, OR CONSEQUENTIAL DAMAGES (INCLUDING, BUT NOT +** LIMITED TO, PROCUREMENT OF SUBSTITUTE GOODS OR SERVICES; LOSS OF USE, +** DATA, OR PROFITS; OR BUSINESS INTERRUPTION) HOWEVER CAUSED AND ON ANY +** THEORY OF LIABILITY, WHETHER IN CONTRACT, STRICT LIABILITY, OR TORT +** (INCLUDING NEGLIGENCE OR OTHERWISE) ARISING IN ANY WAY OUT OF THE USE +** OF THIS SOFTWARE, EVEN IF ADVISED OF THE POSSIBILITY OF SUCH DAMAGE." +** +** $QT_END_LICENSE$ +** +****************************************************************************/ +//! [4] + +

Heading

Hello you

+ +//! [4] + +//! [5] +

Heading

The text...

Next heading

+//! [5] + +//! [6] +

Heading

The text...

Next heading

+//! [6] + +//! [7] + +//! [7] + +//! [9] +QDomElement e = //... +//... +QString s = e.text() +//! [9] + +//! [11] +QDomDocument doc = // ... +QDomElement root = doc.firstChildElement("database"); +QDomElement elt = root.firstChildElement("entry"); +for (; !elt.isNull(); elt = elt.nextSiblingElement("entry")) { + // ... +} +//! [11] + +//! [12] +

+//! [12] + +//! [13] +

Hello Qt ]]>

+//! [13] + +//! [14] +Hello Qt +//! [14] + +//! [15] + +//! [15] diff --git a/src/xml/doc/snippets/snippets.pro b/src/xml/doc/snippets/snippets.pro index df72b89d98..2de9693561 100644 --- a/src/xml/doc/snippets/snippets.pro +++ b/src/xml/doc/snippets/snippets.pro @@ -7,3 +7,7 @@ QT += xml #! [qmake_use] load(qt_common) + +QT += core xml + +SOURCES += code/src_xml_dom_qdom.cpp -- cgit v1.2.3