summaryrefslogtreecommitdiff
diff options
context:
space:
mode:
authorTopi Reinio <topi.reinio@digia.com>2015-09-30 12:00:20 +0200
committerTopi Reiniƶ <topi.reinio@digia.com>2015-09-30 14:04:17 +0000
commitff8495c94db3ce26ff5bb3c604baf67feb984610 (patch)
tree047674ca79c749d94da122b2801dcc6d7760ad17
parent0e5b9dc4a8ef78b54eb686cfd8aa2f402e4549b1 (diff)
downloadqtdoc-ff8495c94db3ce26ff5bb3c604baf67feb984610.tar.gz
Doc: Remove superfluous example
The files of the 'texteditor' example under the /examples are not referred to in the tutorial documentation that originally introduced it, nor is any example documentation generated for it. Remove the example as it ends up being copied into binary packages, which is not intended. This commit partially reverts 5cd576ea736d94cf0c95d4325d6367873ad338df. Change-Id: Iff121f6f0a55c5b47cd6420559e184f599db3a3e Task-number: QTBUG-48501 Reviewed-by: Friedemann Kleint <Friedemann.Kleint@theqtcompany.com> Reviewed-by: Venugopal Shivashankar <venugopal.shivashankar@digia.com>
-rw-r--r--doc/config/qtdoc.qdocconf6
-rw-r--r--examples/texteditor/documenthandler.cpp123
-rw-r--r--examples/texteditor/documenthandler.h87
-rw-r--r--examples/texteditor/images/editcopy.pngbin1468 -> 0 bytes
-rw-r--r--examples/texteditor/images/editcut.pngbin1512 -> 0 bytes
-rw-r--r--examples/texteditor/images/editpaste.pngbin1906 -> 0 bytes
-rw-r--r--examples/texteditor/images/filenew.pngbin1172 -> 0 bytes
-rw-r--r--examples/texteditor/images/fileopen.pngbin2168 -> 0 bytes
-rw-r--r--examples/texteditor/images/filesave.pngbin1206 -> 0 bytes
-rw-r--r--examples/texteditor/images/qt-logo.pngbin3960 -> 0 bytes
-rw-r--r--examples/texteditor/main.cpp58
-rw-r--r--examples/texteditor/main.qml203
-rw-r--r--examples/texteditor/qml.qrc12
-rw-r--r--examples/texteditor/texteditor.pro17
14 files changed, 2 insertions, 504 deletions
diff --git a/doc/config/qtdoc.qdocconf b/doc/config/qtdoc.qdocconf
index a2013df4..072b38d9 100644
--- a/doc/config/qtdoc.qdocconf
+++ b/doc/config/qtdoc.qdocconf
@@ -73,13 +73,11 @@ imagedirs += ../src/images \
../images
sourcedirs += \
- ../src \
- ../../examples
+ ../src
exampledirs += \
../src \
- ../snippets \
- ../../examples
+ ../snippets
# Don't parse files in snippets directory
excludedirs += \
diff --git a/examples/texteditor/documenthandler.cpp b/examples/texteditor/documenthandler.cpp
deleted file mode 100644
index fd2aa2ba..00000000
--- a/examples/texteditor/documenthandler.cpp
+++ /dev/null
@@ -1,123 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2015 The Qt Company Ltd.
-** Contact: http://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** 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$
-**
-****************************************************************************/
-
-#include "documenthandler.h"
-
-DocumentHandler::DocumentHandler(QObject *parent) :
- QObject(parent)
-{
-}
-
-/*
- * Returns the current file's URL.
- */
-QUrl DocumentHandler::fileUrl() const
-{
- return m_fileUrl;
-}
-
-/*
- * Returns the currently opened document's content.
- */
-QString DocumentHandler::text() const
-{
- return m_text;
-}
-
-/*
- * Returns the currently opened document's title.
- */
-QString DocumentHandler::documentTitle() const
-{
- return m_documentTitle;
-}
-
-/*
- * Saves the current content with the given file URL.
- */
-void DocumentHandler::saveFile(const QUrl &arg) const
-{
- QFile file(arg.toLocalFile());
- if (file.open(QFile::WriteOnly | QFile::Truncate)) {
- QTextStream out(&file);
- out << text();
- }
-}
-
-/*
- * Sets the file's URL. Called when a file is opened.
- */
-void DocumentHandler::setFileUrl(const QUrl &arg)
-{
- if (m_fileUrl != arg) {
- m_fileUrl = arg;
- QString fileName = arg.fileName();
- QFile file(arg.toLocalFile());
- if (file.open(QFile::ReadOnly)) {
- setText(QString(file.readAll()));
- if (fileName.isEmpty())
- m_documentTitle = QStringLiteral("untitled");
- else
- m_documentTitle = fileName;
- emit textChanged();
- emit documentTitleChanged();
- }
- emit fileUrlChanged();
- }
-}
-
-/*!
- * Sets the currently opened document's content.
- *
- */
-void DocumentHandler::setText(const QString &arg)
-{
- m_text = arg;
- emit textChanged();
-}
-
-/*
- * Sets the currently opened document's title.
- */
-void DocumentHandler::setDocumentTitle(QString arg)
-{
- m_documentTitle = arg;
- emit documentTitleChanged();
-}
diff --git a/examples/texteditor/documenthandler.h b/examples/texteditor/documenthandler.h
deleted file mode 100644
index 74c0992d..00000000
--- a/examples/texteditor/documenthandler.h
+++ /dev/null
@@ -1,87 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2015 The Qt Company Ltd.
-** Contact: http://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** 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$
-**
-****************************************************************************/
-
-#ifndef DOCUMENTHANDLER_H
-#define DOCUMENTHANDLER_H
-
-#include <QObject>
-#include <QUrl>
-#include <QString>
-#include <QQuickTextDocument>
-
-#include <QtGui/QTextCharFormat>
-#include <QtCore/QTextCodec>
-
-#include <qqmlfile.h>
-
-class DocumentHandler : public QObject
-{
- Q_OBJECT
-public:
- explicit DocumentHandler(QObject *parent = 0);
-
- Q_PROPERTY(QUrl fileUrl READ fileUrl WRITE setFileUrl NOTIFY fileUrlChanged)
- Q_PROPERTY(QString text READ text WRITE setText NOTIFY textChanged)
- Q_PROPERTY(QString documentTitle READ documentTitle WRITE setDocumentTitle NOTIFY documentTitleChanged)
-
-public:
- QUrl fileUrl() const;
- QString text() const;
- QString documentTitle() const;
-
-public Q_SLOTS:
- void setFileUrl(const QUrl &arg);
- void setText(const QString &arg);
- void setDocumentTitle(QString arg);
-
- void saveFile(const QUrl &arg) const;
-
-Q_SIGNALS:
- void fileUrlChanged();
- void textChanged();
- void documentTitleChanged();
-
-private:
- QUrl m_fileUrl;
- QString m_text;
- QString m_documentTitle;
-};
-
-#endif // DOCUMENTHANDLER_H
diff --git a/examples/texteditor/images/editcopy.png b/examples/texteditor/images/editcopy.png
deleted file mode 100644
index f5513644..00000000
--- a/examples/texteditor/images/editcopy.png
+++ /dev/null
Binary files differ
diff --git a/examples/texteditor/images/editcut.png b/examples/texteditor/images/editcut.png
deleted file mode 100644
index a784fd57..00000000
--- a/examples/texteditor/images/editcut.png
+++ /dev/null
Binary files differ
diff --git a/examples/texteditor/images/editpaste.png b/examples/texteditor/images/editpaste.png
deleted file mode 100644
index 64c0b2d6..00000000
--- a/examples/texteditor/images/editpaste.png
+++ /dev/null
Binary files differ
diff --git a/examples/texteditor/images/filenew.png b/examples/texteditor/images/filenew.png
deleted file mode 100644
index d3882c7b..00000000
--- a/examples/texteditor/images/filenew.png
+++ /dev/null
Binary files differ
diff --git a/examples/texteditor/images/fileopen.png b/examples/texteditor/images/fileopen.png
deleted file mode 100644
index fc06c5ec..00000000
--- a/examples/texteditor/images/fileopen.png
+++ /dev/null
Binary files differ
diff --git a/examples/texteditor/images/filesave.png b/examples/texteditor/images/filesave.png
deleted file mode 100644
index b41ecf53..00000000
--- a/examples/texteditor/images/filesave.png
+++ /dev/null
Binary files differ
diff --git a/examples/texteditor/images/qt-logo.png b/examples/texteditor/images/qt-logo.png
deleted file mode 100644
index 6dedc8bf..00000000
--- a/examples/texteditor/images/qt-logo.png
+++ /dev/null
Binary files differ
diff --git a/examples/texteditor/main.cpp b/examples/texteditor/main.cpp
deleted file mode 100644
index 4083e185..00000000
--- a/examples/texteditor/main.cpp
+++ /dev/null
@@ -1,58 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2015 The Qt Company Ltd.
-** Contact: http://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** 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$
-**
-****************************************************************************/
-
-#include <QApplication>
-#include <QQmlApplicationEngine>
-#include "documenthandler.h"
-#include <QQmlEngine>
-
-
-int main(int argc, char *argv[])
-{
- QApplication app(argc, argv);
-
- QQmlApplicationEngine engine;
-
- //register the DocumentHandler QML type from the org.qtproject.example namespace
- qmlRegisterType<DocumentHandler>("org.qtproject.example", 1, 0, "DocumentHandler");
- engine.load(QUrl(QStringLiteral("qrc:/main.qml")));
-
- return app.exec();
-}
diff --git a/examples/texteditor/main.qml b/examples/texteditor/main.qml
deleted file mode 100644
index 085e4c7d..00000000
--- a/examples/texteditor/main.qml
+++ /dev/null
@@ -1,203 +0,0 @@
-/****************************************************************************
-**
-** Copyright (C) 2015 The Qt Company Ltd.
-** Contact: http://www.qt.io/licensing/
-**
-** This file is part of the documentation of the Qt Toolkit.
-**
-** $QT_BEGIN_LICENSE:BSD$
-** 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$
-**
-****************************************************************************/
-
-//QML import statements
-import QtQuick 2.3
-import QtQuick.Controls 1.2
-import QtQuick.Window 2.1
-import QtQuick.Layouts 1.0
-import org.qtproject.example 1.0
-import QtQuick.Dialogs 1.2
-
-//main window
-ApplicationWindow {
- id: applicationWindow1
- visible: true
- width: 640
- height: 480
- title: qsTr(document.documentTitle + " Text Editor Example")
-
- menuBar: MenuBar {
- Menu {
- title: qsTr("File")
- MenuItem {
- text: qsTr("&Open")
- action: fileOpenAction
- }
- MenuItem {
- text: qsTr("&Save")
- action: fileSaveAction
- }
- MenuItem {
- text: qsTr("Exit")
- onTriggered: Qt.quit();
- }
- }
- }
- toolBar: ToolBar {
- id: toolBar
-
- RowLayout {
- id: rowToolBar
- spacing: 0.3
-
- ToolButton {
- id: newToolButton
- anchors.left: parent.left
- iconName: "new_icon"
- iconSource: "images/filenew.png"
- action: newAction
- }
-
- ToolButton {
- id: openToolButton
- anchors.left: newToolButton.right
- transformOrigin: Item.Center
- iconSource: "images/fileopen.png"
- iconName: "open_icon"
- action: fileOpenAction
- }
-
- ToolButton {
- id: saveToolButton
- text: qsTr("")
- iconSource: "images/filesave.png"
- iconName: "save_icon"
- isDefault: false
- visible: true
- checkable: false
- anchors.left: openToolButton.right
- action: fileSaveAction
- }
-
- ToolButton {
- id: cutToolButton
- iconSource: "images/editcut.png"
- iconName: "cut_icon"
- anchors.left: saveToolButton.right
- action: cutAction;
- }
-
- ToolButton {
- id: copyToolButton
- iconSource: "images/editcopy.png"
- iconName: "copy_icon"
- anchors.left: cutToolButton.right
- action: copyAction
- }
-
- ToolButton {
- id: pasteToolbutton
- iconSource: "images/editpaste.png"
- iconName: "paste_icon"
- anchors.left: copyToolButton.right
- action: pasteAction
- }
- }
- }
-
- TextArea {
- id: textArea
- text: document.text
- anchors.fill: parent
- }
-
- DocumentHandler {
- id: document
- }
-
- Action {
- id: newAction
- text: "New"
- shortcut: StandardKey.New
- onTriggered: textArea.text = qsTr("")
- }
-
- Action {
- id: cutAction
- text: "Cut"
- shortcut: StandardKey.Cut
- onTriggered: textArea.cut()
- }
-
- Action {
- id: copyAction
- text: "Copy"
- shortcut: StandardKey.Copy
- onTriggered: textArea.copy()
- }
-
- Action {
- id: pasteAction
- text: "Paste"
- shortcut: StandardKey.Paste
- onTriggered: textArea.paste()
- }
-
- Action {
- id: fileOpenAction
- text: "Open"
- shortcut: StandardKey.Open
- onTriggered: fileOpenDialog.open()
- }
-
- Action {
- id: fileSaveAction
- text: "Open"
- shortcut: StandardKey.Save
- onTriggered: fileSaveDialog.open()
- }
-
- FileDialog {
- id: fileOpenDialog
- title: "Please choose a file to open"
- nameFilters: ["Text files (*.txt)"]
- onAccepted: document.fileUrl = fileUrl
- }
-
- FileDialog {
- id: fileSaveDialog
- title: "Please enter the file to save"
- nameFilters: ["Text files (*.txt)"]
- selectExisting: false
- onAccepted: document.saveFile(fileUrl)
- }
-
-}
diff --git a/examples/texteditor/qml.qrc b/examples/texteditor/qml.qrc
deleted file mode 100644
index 455b940d..00000000
--- a/examples/texteditor/qml.qrc
+++ /dev/null
@@ -1,12 +0,0 @@
-<RCC>
- <qresource prefix="/">
- <file>main.qml</file>
- <file>images/editcopy.png</file>
- <file>images/editcut.png</file>
- <file>images/editpaste.png</file>
- <file>images/filenew.png</file>
- <file>images/fileopen.png</file>
- <file>images/filesave.png</file>
- <file>images/qt-logo.png</file>
- </qresource>
-</RCC>
diff --git a/examples/texteditor/texteditor.pro b/examples/texteditor/texteditor.pro
deleted file mode 100644
index f0a2e4aa..00000000
--- a/examples/texteditor/texteditor.pro
+++ /dev/null
@@ -1,17 +0,0 @@
-TEMPLATE = app
-
-QT += qml quick widgets
-
-SOURCES += main.cpp \
- documenthandler.cpp
-
-RESOURCES += qml.qrc
-
-# Additional import path used to resolve QML modules in Qt Creator's code model
-QML_IMPORT_PATH =
-
-# Default rules for deployment.
-include(deployment.pri)
-
-HEADERS += \
- documenthandler.h