Doc: Added the missing example snippets
The snippet files referred were outside the scope exampledirs for QtCore. I made of a copy of those files in the snippets folder to fix this issue. Task-number: QTBUG-29755 Change-Id: I2f765104394071d035e9cee610945ae290033deb Reviewed-by: Jerome Pasion <jerome.pasion@digia.com> Reviewed-by: Topi Reiniö <topi.reinio@digia.com> Reviewed-by: Martin Smith <martin.smith@digia.com> Reviewed-by: Nico Vertriest <nico.vertriest@digia.com>
This commit is contained in:
parent
a00e74914c
commit
f28b6f8453
65
src/corelib/doc/snippets/plugins/extrafiltersplugin.h
Normal file
65
src/corelib/doc/snippets/plugins/extrafiltersplugin.h
Normal file
@ -0,0 +1,65 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
|
||||
** Contact: http://www.qt-project.org/legal
|
||||
**
|
||||
** This file is part of the examples 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 Digia Plc and its Subsidiary(-ies) 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 EXTRAFILTERSPLUGIN_H
|
||||
#define EXTRAFILTERSPLUGIN_H
|
||||
|
||||
//! [0]
|
||||
#include <QObject>
|
||||
#include <QtPlugin>
|
||||
#include <QStringList>
|
||||
#include <QImage>
|
||||
|
||||
#include <plugandpaint/interfaces.h>
|
||||
|
||||
class ExtraFiltersPlugin : public QObject, public FilterInterface
|
||||
{
|
||||
Q_OBJECT
|
||||
Q_PLUGIN_METADATA(IID "org.qt-project.Qt.Examples.PlugAndPaint.FilterInterface" FILE "extrafilters.json")
|
||||
Q_INTERFACES(FilterInterface)
|
||||
|
||||
public:
|
||||
QStringList filters() const;
|
||||
QImage filterImage(const QString &filter, const QImage &image,
|
||||
QWidget *parent);
|
||||
};
|
||||
//! [0]
|
||||
|
||||
#endif
|
114
src/corelib/doc/snippets/plugins/interfaces.h
Normal file
114
src/corelib/doc/snippets/plugins/interfaces.h
Normal file
@ -0,0 +1,114 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
|
||||
** Contact: http://www.qt-project.org/legal
|
||||
**
|
||||
** This file is part of the examples 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 Digia Plc and its Subsidiary(-ies) 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 INTERFACES_H
|
||||
#define INTERFACES_H
|
||||
|
||||
#include <QtPlugin>
|
||||
|
||||
QT_BEGIN_NAMESPACE
|
||||
class QImage;
|
||||
class QPainter;
|
||||
class QWidget;
|
||||
class QPainterPath;
|
||||
class QPoint;
|
||||
class QRect;
|
||||
class QString;
|
||||
class QStringList;
|
||||
QT_END_NAMESPACE
|
||||
|
||||
//! [0]
|
||||
class BrushInterface
|
||||
{
|
||||
public:
|
||||
virtual ~BrushInterface() {}
|
||||
|
||||
virtual QStringList brushes() const = 0;
|
||||
virtual QRect mousePress(const QString &brush, QPainter &painter,
|
||||
const QPoint &pos) = 0;
|
||||
virtual QRect mouseMove(const QString &brush, QPainter &painter,
|
||||
const QPoint &oldPos, const QPoint &newPos) = 0;
|
||||
virtual QRect mouseRelease(const QString &brush, QPainter &painter,
|
||||
const QPoint &pos) = 0;
|
||||
};
|
||||
//! [0]
|
||||
|
||||
//! [1]
|
||||
class ShapeInterface
|
||||
{
|
||||
public:
|
||||
virtual ~ShapeInterface() {}
|
||||
|
||||
virtual QStringList shapes() const = 0;
|
||||
virtual QPainterPath generateShape(const QString &shape,
|
||||
QWidget *parent) = 0;
|
||||
};
|
||||
//! [1]
|
||||
|
||||
//! [2]
|
||||
class FilterInterface
|
||||
{
|
||||
public:
|
||||
virtual ~FilterInterface() {}
|
||||
|
||||
virtual QStringList filters() const = 0;
|
||||
virtual QImage filterImage(const QString &filter, const QImage &image,
|
||||
QWidget *parent) = 0;
|
||||
};
|
||||
//! [2]
|
||||
|
||||
QT_BEGIN_NAMESPACE
|
||||
//! [3] //! [4]
|
||||
#define BrushInterface_iid "org.qt-project.Qt.Examples.PlugAndPaint.BrushInterface"
|
||||
|
||||
Q_DECLARE_INTERFACE(BrushInterface, BrushInterface_iid)
|
||||
//! [3]
|
||||
|
||||
#define ShapeInterface_iid "org.qt-project.Qt.Examples.PlugAndPaint.ShapeInterface"
|
||||
|
||||
Q_DECLARE_INTERFACE(ShapeInterface, ShapeInterface_iid)
|
||||
//! [5]
|
||||
#define FilterInterface_iid "org.qt-project.Qt.Examples.PlugAndPaint.FilterInterface"
|
||||
|
||||
Q_DECLARE_INTERFACE(FilterInterface, FilterInterface_iid)
|
||||
//! [4] //! [5]
|
||||
QT_END_NAMESPACE
|
||||
|
||||
#endif
|
145
src/corelib/doc/snippets/timers/analogclock.cpp
Normal file
145
src/corelib/doc/snippets/timers/analogclock.cpp
Normal file
@ -0,0 +1,145 @@
|
||||
/****************************************************************************
|
||||
**
|
||||
** Copyright (C) 2012 Digia Plc and/or its subsidiary(-ies).
|
||||
** Contact: http://www.qt-project.org/legal
|
||||
**
|
||||
** This file is part of the examples 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 Digia Plc and its Subsidiary(-ies) 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 <QtWidgets>
|
||||
|
||||
#include "analogclock.h"
|
||||
|
||||
//! [0] //! [1]
|
||||
AnalogClock::AnalogClock(QWidget *parent)
|
||||
//! [0] //! [2]
|
||||
: QWidget(parent)
|
||||
//! [2] //! [3]
|
||||
{
|
||||
//! [3] //! [4]
|
||||
QTimer *timer = new QTimer(this);
|
||||
//! [4] //! [5]
|
||||
connect(timer, SIGNAL(timeout()), this, SLOT(update()));
|
||||
//! [5] //! [6]
|
||||
timer->start(1000);
|
||||
//! [6]
|
||||
|
||||
setWindowTitle(tr("Analog Clock"));
|
||||
resize(200, 200);
|
||||
//! [7]
|
||||
}
|
||||
//! [1] //! [7]
|
||||
|
||||
//! [8] //! [9]
|
||||
void AnalogClock::paintEvent(QPaintEvent *)
|
||||
//! [8] //! [10]
|
||||
{
|
||||
static const QPoint hourHand[3] = {
|
||||
QPoint(7, 8),
|
||||
QPoint(-7, 8),
|
||||
QPoint(0, -40)
|
||||
};
|
||||
static const QPoint minuteHand[3] = {
|
||||
QPoint(7, 8),
|
||||
QPoint(-7, 8),
|
||||
QPoint(0, -70)
|
||||
};
|
||||
|
||||
QColor hourColor(127, 0, 127);
|
||||
QColor minuteColor(0, 127, 127, 191);
|
||||
|
||||
int side = qMin(width(), height());
|
||||
QTime time = QTime::currentTime();
|
||||
//! [10]
|
||||
|
||||
//! [11]
|
||||
QPainter painter(this);
|
||||
//! [11] //! [12]
|
||||
painter.setRenderHint(QPainter::Antialiasing);
|
||||
//! [12] //! [13]
|
||||
painter.translate(width() / 2, height() / 2);
|
||||
//! [13] //! [14]
|
||||
painter.scale(side / 200.0, side / 200.0);
|
||||
//! [9] //! [14]
|
||||
|
||||
//! [15]
|
||||
painter.setPen(Qt::NoPen);
|
||||
//! [15] //! [16]
|
||||
painter.setBrush(hourColor);
|
||||
//! [16]
|
||||
|
||||
//! [17] //! [18]
|
||||
painter.save();
|
||||
//! [17] //! [19]
|
||||
painter.rotate(30.0 * ((time.hour() + time.minute() / 60.0)));
|
||||
painter.drawConvexPolygon(hourHand, 3);
|
||||
painter.restore();
|
||||
//! [18] //! [19]
|
||||
|
||||
//! [20]
|
||||
painter.setPen(hourColor);
|
||||
//! [20] //! [21]
|
||||
|
||||
for (int i = 0; i < 12; ++i) {
|
||||
painter.drawLine(88, 0, 96, 0);
|
||||
painter.rotate(30.0);
|
||||
}
|
||||
//! [21]
|
||||
|
||||
//! [22]
|
||||
painter.setPen(Qt::NoPen);
|
||||
//! [22] //! [23]
|
||||
painter.setBrush(minuteColor);
|
||||
|
||||
//! [24]
|
||||
painter.save();
|
||||
painter.rotate(6.0 * (time.minute() + time.second() / 60.0));
|
||||
painter.drawConvexPolygon(minuteHand, 3);
|
||||
painter.restore();
|
||||
//! [23] //! [24]
|
||||
|
||||
//! [25]
|
||||
painter.setPen(minuteColor);
|
||||
//! [25] //! [26]
|
||||
|
||||
//! [27]
|
||||
for (int j = 0; j < 60; ++j) {
|
||||
if ((j % 5) != 0)
|
||||
painter.drawLine(92, 0, 96, 0);
|
||||
painter.rotate(6.0);
|
||||
}
|
||||
//! [27]
|
||||
}
|
||||
//! [26]
|
@ -184,12 +184,12 @@
|
||||
|
||||
For example, here's the definition of an interface class:
|
||||
|
||||
\snippet tools/plugandpaint/interfaces.h 2
|
||||
\snippet plugins/interfaces.h 2
|
||||
|
||||
Here's the definition of a plugin class that implements that
|
||||
interface:
|
||||
|
||||
\snippet tools/plugandpaintplugins/extrafilters/extrafiltersplugin.h 0
|
||||
\snippet plugins/extrafiltersplugin.h 0
|
||||
|
||||
The \l{tools/plugandpaint}{Plug & Paint} example documentation
|
||||
explains this process in detail. See also \l{Creating Custom
|
||||
|
@ -102,14 +102,14 @@
|
||||
QTimer to redraw a widget at regular intervals. From \c{AnalogClock}'s
|
||||
implementation:
|
||||
|
||||
\snippet analogclock.cpp 0
|
||||
\snippet analogclock.cpp 2
|
||||
\snippet analogclock.cpp 3
|
||||
\snippet analogclock.cpp 4
|
||||
\snippet analogclock.cpp 5
|
||||
\snippet analogclock.cpp 6
|
||||
\snippet timers/analogclock.cpp 0
|
||||
\snippet timers/analogclock.cpp 2
|
||||
\snippet timers/analogclock.cpp 3
|
||||
\snippet timers/analogclock.cpp 4
|
||||
\snippet timers/analogclock.cpp 5
|
||||
\snippet timers/analogclock.cpp 6
|
||||
\dots
|
||||
\snippet analogclock.cpp 7
|
||||
\snippet timers/analogclock.cpp 7
|
||||
|
||||
Every second, QTimer will call the QWidget::update() slot to
|
||||
refresh the clock's display.
|
||||
|
@ -2274,7 +2274,6 @@ void QAbstractItemModel::doSetRoleNames(const QHash<int,QByteArray> &roleNames)
|
||||
|
||||
Returns the model's role names.
|
||||
|
||||
\sa setRoleNames()
|
||||
*/
|
||||
QHash<int,QByteArray> QAbstractItemModel::roleNames() const
|
||||
{
|
||||
|
Loading…
Reference in New Issue
Block a user