diff options
Diffstat (limited to 'doc/codesnippets/doc/src/snippets/xml')
12 files changed, 1106 insertions, 0 deletions
diff --git a/doc/codesnippets/doc/src/snippets/xml/prettyprint/main.cpp b/doc/codesnippets/doc/src/snippets/xml/prettyprint/main.cpp new file mode 100644 index 000000000..33875ae28 --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/prettyprint/main.cpp @@ -0,0 +1,144 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Nokia. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at http://www.qtsoftware.com/contact. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include <QCoreApplication> +#include <QFile> +#include <QHash> +#include <QPair> +#include <QStringList> +#include <QTextStream> +#include <QXmlStreamReader> + +/* + This class exists for the sole purpose of creating a translation context. + */ +class PrettyPrint +{ + Q_DECLARE_TR_FUNCTIONS(PrettyPrint) +}; + +int main(int argc, char *argv[]) +{ + enum ExitCode + { + Success, + ParseFailure, + ArgumentError, + WriteError, + FileFailure + }; + + QCoreApplication app(argc, argv); + + QTextStream errorStream(stderr); + + if (argc != 2) + { + errorStream << PrettyPrint::tr( + "Usage: prettyprint <path to XML file>\n"); + return ArgumentError; + } + + QString inputFilePath(QCoreApplication::arguments().at(1)); + QFile inputFile(inputFilePath); + + if (!QFile::exists(inputFilePath)) + { + errorStream << PrettyPrint::tr( + "File %1 does not exist.\n").arg(inputFilePath); + return FileFailure; + + } else if (!inputFile.open(QIODevice::ReadOnly)) { + errorStream << PrettyPrint::tr( + "Failed to open file %1.\n").arg(inputFilePath); + return FileFailure; + } + + QFile outputFile; + if (!outputFile.open(stdout, QIODevice::WriteOnly)) + { + QTextStream(stderr) << PrettyPrint::tr("Failed to open stdout."); + return WriteError; + } + + QXmlStreamReader reader(&inputFile); + int indentation = 0; + QHash<int,QPair<int, int> > indentationStack; + + while (!reader.atEnd()) + { + reader.readNext(); + if (reader.isStartElement()) { + indentationStack[indentation] = QPair<int,int>( + reader.lineNumber(), reader.columnNumber()); + indentation += 1; + } else if (reader.isEndElement()) { + indentationStack.remove(indentation); + indentation -= 1; + } + + if (reader.error()) + { + errorStream << PrettyPrint::tr( + "Error: %1 in file %2 at line %3, column %4.\n").arg( + reader.errorString(), inputFilePath, + QString::number(reader.lineNumber()), + QString::number(reader.columnNumber())); + if (indentationStack.contains(indentation-1)) { + int line = indentationStack[indentation-1].first; + int column = indentationStack[indentation-1].second; + errorStream << PrettyPrint::tr( + "Opened at line %1, column %2.\n").arg( + QString::number(line), + QString::number(column)); + } + return ParseFailure; + + } else if (reader.isStartElement() && !reader.name().isEmpty()) { + outputFile.write(QByteArray().fill(' ', indentation)); + outputFile.write(reader.name().toString().toLocal8Bit()); + outputFile.write(QString(" line %1, column %2\n").arg( + reader.lineNumber()).arg(reader.columnNumber()).toLocal8Bit()); + } + } + + return Success; +} diff --git a/doc/codesnippets/doc/src/snippets/xml/prettyprint/prettyprint.pro b/doc/codesnippets/doc/src/snippets/xml/prettyprint/prettyprint.pro new file mode 100644 index 000000000..61945e065 --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/prettyprint/prettyprint.pro @@ -0,0 +1,4 @@ +CONFIG += console +QT -= gui +QT += xml +SOURCES += main.cpp diff --git a/doc/codesnippets/doc/src/snippets/xml/rsslisting/handler.cpp b/doc/codesnippets/doc/src/snippets/xml/rsslisting/handler.cpp new file mode 100644 index 000000000..3ba8d34e7 --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/rsslisting/handler.cpp @@ -0,0 +1,179 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Nokia. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at http://www.qtsoftware.com/contact. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/* +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] +def fatalError(self, exception): + qWarning("Fatal error on line %d, column %d:%s" % (exception.lineNumber(), exception.columnNumber(), exception.message()) + + return False +//! [0] diff --git a/doc/codesnippets/doc/src/snippets/xml/rsslisting/handler.h b/doc/codesnippets/doc/src/snippets/xml/rsslisting/handler.h new file mode 100644 index 000000000..5eb6284a8 --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/rsslisting/handler.h @@ -0,0 +1,75 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Nokia. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at http://www.qtsoftware.com/contact. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef HANDLER_H +#define HANDLER_H + +#include <QObject> +#include <QString> +#include <QXmlDefaultHandler> + +/* Note that QObject must precede QXmlDefaultHandler in the following list. */ + +class Handler : public QObject, public QXmlDefaultHandler +{ + Q_OBJECT +public: + bool startDocument(); + bool startElement(const QString &, const QString &, const QString &qName, + const QXmlAttributes &attr); + bool endElement(const QString &, const QString &, const QString &qName); + bool characters(const QString &chars); + + bool fatalError(const QXmlParseException &exception); + +signals: + void newItem(QString &title, QString &link); + +private: + QString titleString; + QString linkString; + bool inItem; + bool inTitle; + bool inLink; +}; + +#endif + diff --git a/doc/codesnippets/doc/src/snippets/xml/rsslisting/main.cpp b/doc/codesnippets/doc/src/snippets/xml/rsslisting/main.cpp new file mode 100644 index 000000000..1b556dac7 --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/rsslisting/main.cpp @@ -0,0 +1,64 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Nokia. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at http://www.qtsoftware.com/contact. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/* +main.cpp + +Provides the main function for the RSS news reader example. +*/ + +#include <QtGui> + +#include "rsslisting.h" + +/*! + Create an application and a main widget. Open the main widget for + user input, and exit with an appropriate return value when it is + closed. +*/ + +int main(int argc, char **argv) +{ + QApplication app(argc, argv); + RSSListing *rsslisting = new RSSListing; + rsslisting->show(); + return app.exec(); +} diff --git a/doc/codesnippets/doc/src/snippets/xml/rsslisting/rsslisting.cpp b/doc/codesnippets/doc/src/snippets/xml/rsslisting/rsslisting.cpp new file mode 100644 index 000000000..2740bd2c9 --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/rsslisting/rsslisting.cpp @@ -0,0 +1,246 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Nokia. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at http://www.qtsoftware.com/contact. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/* +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(const QHttpResponseHeader &)), + this, SLOT(readData(const 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] +def readData(self, resp): + if resp.statusCode() != 200: + self.http.abort() + else: + xmlInput.setData(self.http.readAll()) + + if newInformation: + ok = xmlReader.parse(xmlInput, True) + newInformation = False + else: + ok = xmlReader.parseContinue() + + if not ok: + self.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; +} + diff --git a/doc/codesnippets/doc/src/snippets/xml/rsslisting/rsslisting.h b/doc/codesnippets/doc/src/snippets/xml/rsslisting/rsslisting.h new file mode 100644 index 000000000..01250dbb5 --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/rsslisting/rsslisting.h @@ -0,0 +1,87 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Nokia. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at http://www.qtsoftware.com/contact. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef RSSLISTING_H +#define RSSLISTING_H + +#include <QHttp> +#include <QWidget> +#include <QXmlInputSource> +#include <QXmlSimpleReader> + +#include "handler.h" + +class QLineEdit; +class QTreeWidget; +class QTreeWidgetItem; +class QPushButton; + +class RSSListing : public QWidget +{ + Q_OBJECT +public: + RSSListing(QWidget *widget = 0); + +public slots: + void addItem(QString &title, QString &link); + void fetch(); + void finished(int id, bool error); + void readData(const QHttpResponseHeader &); + +private: + Handler *handler; + QXmlInputSource xmlInput; + QXmlSimpleReader xmlReader; + + bool newInformation; + + QHttp http; + int connectionId; + + QLineEdit *lineEdit; + QTreeWidget *treeWidget; + QTreeWidgetItem *lastItemCreated; + QPushButton *abortButton; + QPushButton *fetchButton; +}; + +#endif + diff --git a/doc/codesnippets/doc/src/snippets/xml/simpleparse/handler.cpp b/doc/codesnippets/doc/src/snippets/xml/simpleparse/handler.cpp new file mode 100644 index 000000000..214451e4e --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/simpleparse/handler.cpp @@ -0,0 +1,139 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Nokia. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at http://www.qtsoftware.com/contact. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +/* +handler.cpp + +Provides a handler for processing XML elements found by the reader. + +The handler stores the names of elements it finds and their indentation +levels. The indentation level is initially set to zero. +When a starting element is found, the indentation level is increased; +when an ending element is found, the indentation level is decreased. +*/ + +#include <QDebug> +#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() +{ + elementName.clear(); + elementIndentation.clear(); + indentationLevel = 0; + + return true; +} + +/*! + Process each starting element in the XML document. + + Append the element name to the list of elements found; add its + corresponding indentation level to the list of indentation levels. + + Increase the level of indentation by one column. + + We return true to indicate that parsing should continue. +*/ + +bool Handler::startElement(const QString &, const QString &, + const QString & qName, const QXmlAttributes &) +{ + elementName.append(qName); + elementIndentation.append(indentationLevel); + indentationLevel += 1; + + return true; +} + +/*! + Process each ending element in the XML document. + + Decrease the level of indentation by one column. + + We return true to indicate that parsing should continue. +*/ + +bool Handler::endElement(const QString &, const QString &, + const QString &) +{ + indentationLevel -= 1; + + return true; +} + +/*! + Report a fatal parsing error, and return false to indicate to the reader + that parsing should stop. +*/ + +bool Handler::fatalError (const QXmlParseException & exception) +{ + qWarning() << QString("Fatal error on line %1, column %2: %3").arg( + exception.lineNumber()).arg(exception.columnNumber()).arg( + exception.message()); + + return false; +} + +/*! + Return the list of element names found. +*/ + +QStringList& Handler::names () +{ + return elementName; +} + +/*! + Return the list of indentations used for each element found. +*/ + +QList<int>& Handler::indentations () +{ + return elementIndentation; +} diff --git a/doc/codesnippets/doc/src/snippets/xml/simpleparse/handler.h b/doc/codesnippets/doc/src/snippets/xml/simpleparse/handler.h new file mode 100644 index 000000000..b298dedd6 --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/simpleparse/handler.h @@ -0,0 +1,68 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Nokia. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at http://www.qtsoftware.com/contact. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#ifndef HANDLER_H +#define HANDLER_H + +#include <qstring.h> +#include <qxml.h> + +class Handler : public QXmlDefaultHandler +{ +public: + bool startDocument(); + bool startElement(const QString &, const QString &, const QString &qName, + const QXmlAttributes &); + bool endElement(const QString &, const QString &, const QString &); + + bool fatalError(const QXmlParseException &exception); + + QStringList& names(); + QList<int>& indentations(); + +private: + int indentationLevel; + QStringList elementName; + QList<int> elementIndentation; +}; + +#endif + diff --git a/doc/codesnippets/doc/src/snippets/xml/simpleparse/main.cpp b/doc/codesnippets/doc/src/snippets/xml/simpleparse/main.cpp new file mode 100644 index 000000000..4b2f2827e --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/simpleparse/main.cpp @@ -0,0 +1,88 @@ +/**************************************************************************** +** +** Copyright (C) 2009 Nokia Corporation and/or its subsidiary(-ies). +** Contact: Nokia Corporation (qt-info@nokia.com) +** +** This file is part of the documentation of the Qt Toolkit. +** +** $QT_BEGIN_LICENSE:LGPL$ +** Commercial Usage +** Licensees holding valid Qt Commercial licenses may use this file in +** accordance with the Qt Commercial License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Nokia. +** +** GNU Lesser General Public License Usage +** Alternatively, this file may be used under the terms of the GNU Lesser +** General Public License version 2.1 as published by the Free Software +** Foundation and appearing in the file LICENSE.LGPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU Lesser General Public License version 2.1 requirements +** will be met: http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html. +** +** In addition, as a special exception, Nokia gives you certain +** additional rights. These rights are described in the Nokia Qt LGPL +** Exception version 1.0, included in the file LGPL_EXCEPTION.txt in this +** package. +** +** GNU General Public License Usage +** Alternatively, this file may be used under the terms of the GNU +** General Public License version 3.0 as published by the Free Software +** Foundation and appearing in the file LICENSE.GPL included in the +** packaging of this file. Please review the following information to +** ensure the GNU General Public License version 3.0 requirements will be +** met: http://www.gnu.org/copyleft/gpl.html. +** +** If you are unsure which license is appropriate for your use, please +** contact the sales department at http://www.qtsoftware.com/contact. +** $QT_END_LICENSE$ +** +****************************************************************************/ + +#include <qfile.h> +#include <qxml.h> +#include "handler.h" + +#include <iostream> + +int main(int argc, char **argv) +{ + if (argc != 2) { + std::cout << "Usage: " << argv[0] << " <filename>" << std::endl; + return 1; + } + + QFile *file = new QFile(argv[1]); + +//! [0] + xmlReader = QXmlSimpleReader() + source = QXmlInputSource(filename) +//! [0] + +//! [1] + handler = Handler() + xmlReader.setContentHandler(handler) + xmlReader.setErrorHandler(handler) +//! [1] + +//! [2] + ok = xmlReader.parse(source) + + if not ok: + print "Parsing failed." +//! [2] + else { + QStringList names = handler->names(); + QList<int> indentations = handler->indentations(); + + int items = names.count(); + + for (int i = 0; i < items; ++i) { + for (int j = 0; j < indentations[i]; ++j) + std::cout << " "; + std::cout << names[i].toLocal8Bit().constData() << std::endl; + } + } + + return 0; +} diff --git a/doc/codesnippets/doc/src/snippets/xml/simpleparse/simpleparse.pro b/doc/codesnippets/doc/src/snippets/xml/simpleparse/simpleparse.pro new file mode 100644 index 000000000..fbea770b9 --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/simpleparse/simpleparse.pro @@ -0,0 +1,4 @@ +HEADERS = handler.h +SOURCES = handler.cpp \ + main.cpp +QT += xml diff --git a/doc/codesnippets/doc/src/snippets/xml/xml.pro b/doc/codesnippets/doc/src/snippets/xml/xml.pro new file mode 100644 index 000000000..a321badb3 --- /dev/null +++ b/doc/codesnippets/doc/src/snippets/xml/xml.pro @@ -0,0 +1,8 @@ +### A qmake file for the snippets. *** This is not for distribution. *** +# +# The snippets that don't work are commented out. + +TEMPLATE = subdirs +SUBDIRS = prettyprint +# rsslisting +# simpleparse |