diff options
Diffstat (limited to 'src/extras/doc')
33 files changed, 51 insertions, 794 deletions
diff --git a/src/extras/doc/compat/qtquickextras.qdocconf b/src/extras/doc/compat/qtquickextras.qdocconf deleted file mode 100644 index d36fd909..00000000 --- a/src/extras/doc/compat/qtquickextras.qdocconf +++ /dev/null @@ -1,5 +0,0 @@ -include(../qtquickextras-compat.qdocconf) - -# Workaround for qdoc not parsing relative include paths correctly -exampledirs += ../../../../examples -imagedirs += ../images diff --git a/src/extras/doc/images/circulargauge-angles.png b/src/extras/doc/images/circulargauge-angles.png Binary files differdeleted file mode 100644 index fb93bcaa..00000000 --- a/src/extras/doc/images/circulargauge-angles.png +++ /dev/null diff --git a/src/extras/doc/images/circulargauge-needle-example-2.png b/src/extras/doc/images/circulargauge-needle-example-2.png Binary files differdeleted file mode 100644 index a2b5f322..00000000 --- a/src/extras/doc/images/circulargauge-needle-example-2.png +++ /dev/null diff --git a/src/extras/doc/images/circulargauge-needle.png b/src/extras/doc/images/circulargauge-needle.png Binary files differdeleted file mode 100644 index b2780b41..00000000 --- a/src/extras/doc/images/circulargauge-needle.png +++ /dev/null diff --git a/src/extras/doc/images/circulargauge-reversed.png b/src/extras/doc/images/circulargauge-reversed.png Binary files differdeleted file mode 100644 index aeadfbcc..00000000 --- a/src/extras/doc/images/circulargauge-reversed.png +++ /dev/null diff --git a/src/extras/doc/images/circulargauge-tickmark-indices-values.png b/src/extras/doc/images/circulargauge-tickmark-indices-values.png Binary files differdeleted file mode 100644 index d117f483..00000000 --- a/src/extras/doc/images/circulargauge-tickmark-indices-values.png +++ /dev/null diff --git a/src/extras/doc/images/gauge-minorTickmark-example.png b/src/extras/doc/images/gauge-minorTickmark-example.png Binary files differdeleted file mode 100644 index 591120d6..00000000 --- a/src/extras/doc/images/gauge-minorTickmark-example.png +++ /dev/null diff --git a/src/extras/doc/images/gauge-temperature.png b/src/extras/doc/images/gauge-temperature.png Binary files differdeleted file mode 100644 index 95fc1679..00000000 --- a/src/extras/doc/images/gauge-temperature.png +++ /dev/null diff --git a/src/extras/doc/images/gauge-tickmark-example.png b/src/extras/doc/images/gauge-tickmark-example.png Binary files differdeleted file mode 100644 index c46fb8a5..00000000 --- a/src/extras/doc/images/gauge-tickmark-example.png +++ /dev/null diff --git a/src/extras/doc/images/piemenu-menuitem-example.png b/src/extras/doc/images/piemenu-menuitem-example.png Binary files differdeleted file mode 100644 index 57a2f956..00000000 --- a/src/extras/doc/images/piemenu-menuitem-example.png +++ /dev/null diff --git a/src/extras/doc/images/styling-circulargauge-background-example.png b/src/extras/doc/images/styling-circulargauge-background-example.png Binary files differdeleted file mode 100644 index e816c6f6..00000000 --- a/src/extras/doc/images/styling-circulargauge-background-example.png +++ /dev/null diff --git a/src/extras/doc/images/styling-circulargauge-knob-example.png b/src/extras/doc/images/styling-circulargauge-knob-example.png Binary files differdeleted file mode 100644 index 793a36c2..00000000 --- a/src/extras/doc/images/styling-circulargauge-knob-example.png +++ /dev/null diff --git a/src/extras/doc/images/styling-circulargauge-minorTickmark-example.png b/src/extras/doc/images/styling-circulargauge-minorTickmark-example.png Binary files differdeleted file mode 100644 index f3f2d8d7..00000000 --- a/src/extras/doc/images/styling-circulargauge-minorTickmark-example.png +++ /dev/null diff --git a/src/extras/doc/images/styling-circulargauge-needle-example.png b/src/extras/doc/images/styling-circulargauge-needle-example.png Binary files differdeleted file mode 100644 index 08049fc9..00000000 --- a/src/extras/doc/images/styling-circulargauge-needle-example.png +++ /dev/null diff --git a/src/extras/doc/images/styling-circulargauge-tickmark-example.png b/src/extras/doc/images/styling-circulargauge-tickmark-example.png Binary files differdeleted file mode 100644 index 01c71cd1..00000000 --- a/src/extras/doc/images/styling-circulargauge-tickmark-example.png +++ /dev/null diff --git a/src/extras/doc/images/styling-circulargauge-tickmarkLabel-example.png b/src/extras/doc/images/styling-circulargauge-tickmarkLabel-example.png Binary files differdeleted file mode 100644 index 7520827e..00000000 --- a/src/extras/doc/images/styling-circulargauge-tickmarkLabel-example.png +++ /dev/null diff --git a/src/extras/doc/images/styling-gauge-font-size.png b/src/extras/doc/images/styling-gauge-font-size.png Binary files differdeleted file mode 100644 index 97d7ebb2..00000000 --- a/src/extras/doc/images/styling-gauge-font-size.png +++ /dev/null diff --git a/src/extras/doc/images/styling-gauge-foreground.png b/src/extras/doc/images/styling-gauge-foreground.png Binary files differdeleted file mode 100644 index 5a4f65b9..00000000 --- a/src/extras/doc/images/styling-gauge-foreground.png +++ /dev/null diff --git a/src/extras/doc/images/styling-gauge-minorTickmark.png b/src/extras/doc/images/styling-gauge-minorTickmark.png Binary files differdeleted file mode 100644 index 34e36192..00000000 --- a/src/extras/doc/images/styling-gauge-minorTickmark.png +++ /dev/null diff --git a/src/extras/doc/images/styling-gauge-tickmark.png b/src/extras/doc/images/styling-gauge-tickmark.png Binary files differdeleted file mode 100644 index 1cd4fb8b..00000000 --- a/src/extras/doc/images/styling-gauge-tickmark.png +++ /dev/null diff --git a/src/extras/doc/images/styling-gauge-valueBar.png b/src/extras/doc/images/styling-gauge-valueBar.png Binary files differdeleted file mode 100644 index 581b8240..00000000 --- a/src/extras/doc/images/styling-gauge-valueBar.png +++ /dev/null diff --git a/src/extras/doc/qtquickextras-compat.qdocconf b/src/extras/doc/qtquickextras-compat.qdocconf deleted file mode 100644 index ad171f47..00000000 --- a/src/extras/doc/qtquickextras-compat.qdocconf +++ /dev/null @@ -1,17 +0,0 @@ -include($QT_INSTALL_DOCS/global/qt-defines.qdocconf) -include($QT_INSTALL_DOCS/global/qt-cpp-ignore.qdocconf) - -naturallanguage = en_US -outputencoding = UTF-8 -sourceencoding = UTF-8 - -examples.fileextensions = "*.cpp *.h *.js *.xq *.svg *.xml *.ui *.qhp *.qhcp *.qml *.css" -examples.imageextensions = "*.png *.jpg *.gif" - -headers.fileextensions = "*.ch *.h *.h++ *.hh *.hpp *.hxx" -sources.fileextensions = "*.c++ *.cc *.cpp *.cxx *.mm *.qml *.qdoc" - -#include the external websites -sourcedirs += externalsites - -include(qtquickextras-project.qdocconf) diff --git a/src/extras/doc/qtquickextras-project.qdocconf b/src/extras/doc/qtquickextras-project.qdocconf deleted file mode 100644 index 0e0104c1..00000000 --- a/src/extras/doc/qtquickextras-project.qdocconf +++ /dev/null @@ -1,59 +0,0 @@ -include($QT_INSTALL_DOCS/global/macros.qdocconf) -include($QT_INSTALL_DOCS/global/compat.qdocconf) -#include($QT_INSTALL_DOCS/global/manifest-meta.qdocconf) -include($QT_INSTALL_DOCS/global/qt-html-templates-offline.qdocconf) - -project = QtQuickExtras -description = Qt Quick Extras Reference Documentation -url = http://doc.qt.digia.com/QtQuickExtras/ -version = 1.3 - -qhp.projects = QtQuickExtras - -qhp.QtQuickExtras.file = qtquickextras.qhp -qhp.QtQuickExtras.namespace = org.qt-project.qtquickextras.1.3 -qhp.QtQuickExtras.virtualFolder = qtquickextras -qhp.QtQuickExtras.indexTitle = Qt Quick Extras -qhp.QtQuickExtras.indexRoot = -#qhp.QtQuickExtras.extraFiles = style/qtquickextras.css - -qhp.QtQuickExtras.filterAttributes = qtquickextras 1.3 qtrefdoc -qhp.QtQuickExtras.customFilters.Qt.name = QtQuickExtras 1.3 -qhp.QtQuickExtras.customFilters.Qt.filterAttributes = qtquickextras 1.3 - -qhp.QtQuickExtras.subprojects = qtquickextrasstyles - -qhp.QtQuickExtras.subprojects.qtquickextrasqmltypes.title = Controls QML Types -qhp.QtQuickExtras.subprojects.qtquickextrasqmltypes.indexTitle = Qt Quick Controls QML Types -qhp.QtQuickExtras.subprojects.qtquickextrasqmltypes.selectors = fake:qmlclass # cannot choose qmltypes from a specific group QTBUG-32985 -qhp.QtQuickExtras.subprojects.qtquickextrasqmltypes.sortPages = true - -qhp.QtQuickExtras.subprojects.qtquickextrasstyles.title = Qt Quick Extras Styles Structure -qhp.QtQuickExtras.subprojects.qtquickextrasstyles.indexTitle = Qt Quick Extras Styles Structure -qhp.QtQuickExtras.subprojects.qtquickextrasstyles.type = manual - -# QTBUG-35596: If you're using a shadow build of Qt >= 5.3.1, then uncomment the following line and comment out indexes += ... -#depends = qtqml qtquick qtdoc qtquickcontrols -indexes += $QT_INSTALL_DOCS/qtqml/qtqml.index \ - $QT_INSTALL_DOCS/qtquick/qtquick.index \ - $QT_INSTALL_DOCS/qtdoc/qtdoc.index \ - $QT_INSTALL_DOCS/qtquickcontrols/qtquickcontrols.index - -# Specify the install path under QT_INSTALL_EXAMPLES -# Examples will be installed under quick/extras - -# 'extras' subdirectory is given as part of \example commands -exampledirs += ../../../examples/quick \ - snippets -examplesinstallpath = quick - -headerdirs += ../ - -sourcedirs += ../ - -#sources += ../Private/<stuff> \ - -imagedirs += images - -navigation.landingpage = "Qt Quick Extras" -navigation.qmltypespage = "Qt Quick Extras QML Types" -buildversion = "Qt Quick Extras 1.3" diff --git a/src/extras/doc/qtquickextras.qdocconf b/src/extras/doc/qtquickextras.qdocconf index 10117442..f65630f9 100644 --- a/src/extras/doc/qtquickextras.qdocconf +++ b/src/extras/doc/qtquickextras.qdocconf @@ -1,4 +1,45 @@ -include($QT_INSTALL_DOCS/global/qt-cpp-defines.qdocconf) -include($QT_INSTALL_DOCS/global/fileextensions.qdocconf) +include($QT_INSTALL_DOCS/global/qt-module-defaults.qdocconf) + +project = QtQuickExtras +description = Qt Quick Extras Reference Documentation +version = $QT_VERSION + +qhp.projects = QtQuickExtras + +qhp.QtQuickExtras.file = qtquickextras.qhp +qhp.QtQuickExtras.namespace = org.qt-project.qtquickextras.$QT_VERSION_TAG +qhp.QtQuickExtras.virtualFolder = qtquickextras +qhp.QtQuickExtras.indexTitle = Qt Quick Extras +qhp.QtQuickExtras.indexRoot = + +qhp.QtQuickExtras.filterAttributes = qtquickextras $QT_VERSION qtrefdoc +qhp.QtQuickExtras.customFilters.Qt.name = QtQuickExtras $QT_VERSION +qhp.QtQuickExtras.customFilters.Qt.filterAttributes = qtquickextras $QT_VERSION + +qhp.QtQuickExtras.subprojects = qtquickextrasqmltypes qtquickextrasexamples +qhp.QtQuickExtras.subprojects.qtquickextrasqmltypes.title = Extras QML Types +qhp.QtQuickExtras.subprojects.qtquickextrasqmltypes.indexTitle = Qt Quick Extras QML Types +qhp.QtQuickExtras.subprojects.qtquickextrasqmltypes.selectors = qmlclass +qhp.QtQuickExtras.subprojects.qtquickextrasqmltypes.sortPages = true + +qhp.QtQuickExtras.subprojects.qtquickextrasexamples.title = Extras Examples +qhp.QtQuickExtras.subprojects.qtquickextrasexamples.indexTitle = Qt Quick Extras Examples +qhp.QtQuickExtras.subprojects.qtquickextrasexamples.selectors = fake:example +qhp.QtQuickExtras.subprojects.qtquickextrasexamples.sortPages = true + +depends = qtqml qtquick qtdoc qtquickcontrols + +exampledirs += ../../../examples/quick/extras +examplesinstallpath = quick/extras + +headerdirs += ../ + +sourcedirs += ../ + +#sources += ../Private/<stuff> \ + +imagedirs += images + +navigation.landingpage = "Qt Quick Extras" +navigation.qmltypespage = "Qt Quick Extras QML Types" -include(qtquickextras-project.qdocconf) diff --git a/src/extras/doc/snippets/circulargauge-background-range.qml b/src/extras/doc/snippets/circulargauge-background-range.qml deleted file mode 100644 index 619fc465..00000000 --- a/src/extras/doc/snippets/circulargauge-background-range.qml +++ /dev/null @@ -1,121 +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:FDL$ -** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -//! [range] -import QtQuick 2.0 -import QtQuick.Controls 1.1 -import QtQuick.Extras 1.3 -import QtQuick.Extras.Styles 1.3 -import QtQuick.Extras.Private 1.0 - -Rectangle { - width: 300 - height: 300 - color: "#494d53" - - CircularGauge { - id: gauge - anchors.centerIn: parent - style: CircularGaugeStyle { - id: style - - //! [background] - function degreesToRadians(degrees) { - return degrees * (Math.PI / 180); - } - - - background: Canvas { - onPaint: { - var ctx = getContext("2d"); - ctx.reset(); - - ctx.beginPath(); - ctx.strokeStyle = "#e34c22"; - ctx.lineWidth = outerRadius * 0.02; - - ctx.arc(outerRadius, outerRadius, outerRadius - ctx.lineWidth / 2, - degreesToRadians(valueToAngle(80) - 90), degreesToRadians(valueToAngle(100) - 90)); - ctx.stroke(); - } - } - //! [background] - - //! [tickmark] - tickmark: Rectangle { - visible: styleData.value < 80 || styleData.value % 10 == 0 - implicitWidth: outerRadius * 0.02 - antialiasing: true - implicitHeight: outerRadius * 0.06 - color: styleData.value >= 80 ? "#e34c22" : "#e5e5e5" - } - //! [tickmark] - - //! [minorTickmark] - minorTickmark: Rectangle { - visible: styleData.value < 80 - implicitWidth: outerRadius * 0.01 - antialiasing: true - implicitHeight: outerRadius * 0.03 - color: "#e5e5e5" - } - //! [minorTickmark] - - //! [tickmarkLabel] - tickmarkLabel: Text { - font.pixelSize: Math.max(6, outerRadius * 0.1) - text: styleData.value - color: styleData.value >= 80 ? "#e34c22" : "#e5e5e5" - antialiasing: true - } - //! [tickmarkLabel] - - //! [needle] - needle: Rectangle { - y: outerRadius * 0.15 - implicitWidth: outerRadius * 0.03 - implicitHeight: outerRadius * 0.9 - antialiasing: true - color: "#e5e5e5" - } - //! [needle] - - //! [foreground] - foreground: Item { - Rectangle { - width: outerRadius * 0.2 - height: width - radius: width / 2 - color: "#e5e5e5" - anchors.centerIn: parent - } - } - //! [foreground] - } - } -} -//! [range] diff --git a/src/extras/doc/snippets/circulargauge-tickmark-indices-values.qml b/src/extras/doc/snippets/circulargauge-tickmark-indices-values.qml deleted file mode 100644 index 33781baa..00000000 --- a/src/extras/doc/snippets/circulargauge-tickmark-indices-values.qml +++ /dev/null @@ -1,85 +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:FDL$ -** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -//! [tickmarks] -import QtQuick 2.0 -import QtQuick.Extras 1.3 -import QtQuick.Extras.Styles 1.3 - -Rectangle { - width: 400 - height: 400 - - CircularGauge { - id: gauge - anchors.fill: parent - style: CircularGaugeStyle { - labelInset: outerRadius * 0.2 - - tickmarkLabel: null - - tickmark: Text { - text: styleData.value - - Text { - anchors.horizontalCenter: parent.horizontalCenter - anchors.top: parent.bottom - text: styleData.index - color: "blue" - } - } - - minorTickmark: Text { - text: styleData.value - font.pixelSize: 8 - - Text { - anchors.horizontalCenter: parent.horizontalCenter - anchors.top: parent.bottom - text: styleData.index - font.pixelSize: 8 - color: "blue" - } - } - } - - Text { - id: indexText - text: "Major and minor indices" - anchors.horizontalCenter: parent.horizontalCenter - anchors.bottom: valueText.top - color: "blue" - } - Text { - id: valueText - text: "Major and minor values" - anchors.horizontalCenter: parent.horizontalCenter - anchors.bottom: parent.bottom - } - } -} -//! [tickmarks] diff --git a/src/extras/doc/snippets/styling-gauge.qml b/src/extras/doc/snippets/styling-gauge.qml deleted file mode 100644 index 48cb95ed..00000000 --- a/src/extras/doc/snippets/styling-gauge.qml +++ /dev/null @@ -1,93 +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:FDL$ -** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -//! [all] -import QtQuick 2.2 -import QtQuick.Controls 1.1 -import QtQuick.Extras 1.3 -import QtQuick.Extras.Styles 1.3 - -Rectangle { - width: 100 - height: 220 - color: "#494d53" - - Gauge { - value: 50 - tickmarkStepSize: 20 - minorTickmarkCount: 1 - //! [font-size] - font.pixelSize: 15 - //! [font-size] - anchors.centerIn: parent - anchors.horizontalCenterOffset: -4 - - style: GaugeStyle { - //! [valueBar] - valueBar: Rectangle { - color: "#e34c22" - implicitWidth: 28 - } - //! [valueBar] - - //! [foreground] - foreground: null - //! [foreground] - - //! [tickmark] - tickmark: Item { - implicitWidth: 8 - implicitHeight: 4 - - Rectangle { - x: control.tickmarkAlignment === Qt.AlignLeft - || control.tickmarkAlignment === Qt.AlignTop ? parent.implicitWidth : -28 - width: 28 - height: parent.height - color: "#ffffff" - } - } - //! [tickmark] - - //! [minorTickmark] - minorTickmark: Item { - implicitWidth: 8 - implicitHeight: 2 - - Rectangle { - x: control.tickmarkAlignment === Qt.AlignLeft - || control.tickmarkAlignment === Qt.AlignTop ? parent.implicitWidth : -28 - width: 28 - height: parent.height - color: "#ffffff" - } - } - //! [minorTickmark] - } - } -} -//! [all] diff --git a/src/extras/doc/src/qtquickextras-index.qdoc b/src/extras/doc/src/qtquickextras-index.qdoc index 18e40711..63966614 100644 --- a/src/extras/doc/src/qtquickextras-index.qdoc +++ b/src/extras/doc/src/qtquickextras-index.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \page index.html + \page qtquickextras-index.html \title Qt Quick Extras \brief The Qt Quick Extras module provides a set of UI controls for Qt @@ -51,6 +51,6 @@ \li \l{Qt Quick Extras Overview} \li \l{Qt Quick Extras QML Types}{Qt Quick Extras QML Types} \li \l{Qt Quick Extras Examples} - \li \l{Qt Quick Extras Styles} + \li \l{Qt Quick Controls Styles} \endlist */ diff --git a/src/extras/doc/src/qtquickextras-overview.qdoc b/src/extras/doc/src/qtquickextras-overview.qdoc index 63732c50..5d5edf7c 100644 --- a/src/extras/doc/src/qtquickextras-overview.qdoc +++ b/src/extras/doc/src/qtquickextras-overview.qdoc @@ -64,7 +64,7 @@ import statement in your \c {.qml} file. \code - import QtQuick.Extras 1.3 + import QtQuick.Extras 1.4 \endcode \section1 Interactive controls @@ -81,7 +81,7 @@ \code import QtQuick 2.2 - import QtQuick.Extras 1.3 + import QtQuick.Extras 1.4 Rectangle { DelayButton { diff --git a/src/extras/doc/src/qtquickextras.qdoc b/src/extras/doc/src/qtquickextras.qdoc index 835b14fd..39f81f06 100644 --- a/src/extras/doc/src/qtquickextras.qdoc +++ b/src/extras/doc/src/qtquickextras.qdoc @@ -26,7 +26,7 @@ ****************************************************************************/ /*! - \qmlmodule QtQuick.Extras 1.3 + \qmlmodule QtQuick.Extras 1.4 \title Qt Quick Extras QML Types \ingroup qmlmodules \brief Provides QML types for user interfaces. @@ -36,13 +36,13 @@ \l{Qt Quick} and \l{Qt Quick Controls}. Controls can be styled using the - \l{Qt Quick Extras Styles QML Types}{Styles QML Types}. + \l{Qt Quick Controls Styles QML Types}{Styles QML Types}. The QML types can be imported into your application using the following import statement in your .qml file. \code - import QtQuick.Extras 1.3 + import QtQuick.Extras 1.4 \endcode */ diff --git a/src/extras/doc/src/qtquickextrasstyles-index.qdoc b/src/extras/doc/src/qtquickextrasstyles-index.qdoc deleted file mode 100644 index 6af24bb7..00000000 --- a/src/extras/doc/src/qtquickextrasstyles-index.qdoc +++ /dev/null @@ -1,130 +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:FDL$ -** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \group extrasstyling - \title Styling Extras Controls -*/ - -/*! - \page qtquickextrasstyles-index.html - \title Qt Quick Extras Styles - \brief The Qt Quick Extras Styles submodule provides custom - styles for Qt Quick Extras. - - The Qt Quick Extras Styles module allows custom styling for - \l {Qt Quick Extras}. - - The submodule requires \l{Qt Quick} 2.2. - - \section1 Getting started - - The QML types can be imported into your application using the following - import statement in your \c {.qml} file. - - \code - import QtQuick.Extras.Styles 1.3 - \endcode - - \section1 Styles - - \section2 Base Style - - The Base Style is the default style used when none is specified. It is also - used as a fallback when the specified style cannot be found. - - \image tumbler.png - \caption The Base Style Tumbler. - - \section2 Flat Style - - The Flat Style is designed for touch devices. It was introduced in Qt Quick - Extras Controls 1.3 and requires Qt 5.4. - - \image tumbler-flat-style.png - \caption The Flat Style Tumbler. - - \section2 Selecting Styles - - Qt Quick Extras follow Qt Quick Controls' styling system. You - can apply a different style to the controls by setting the - \e QT_QUICK_CONTROLS_STYLE environment variable to the name of the style. - For example, to use the Flat style, you can do the following: - - \code - QT_QUICK_CONTROLS_STYLE=Flat ./app - \endcode - - This can also be done in C++, using qputenv(): - - \code - qputenv("QT_QUICK_CONTROLS_STYLE", "Flat"); - \endcode - - \section1 Control Styles - \annotatedlist extrasstyles - - \section1 Styling Tutorials - \annotatedlist extrasstyling - - \section1 Related information - - \list - \li \l{Qt Quick} - \li \l{Qt Quick Extras} - \li \l{Qt Quick Extras Styles QML Types} - \endlist -*/ - -/*! - \page qtquickextrasstyles-structure.html - \title Qt Quick Extras Styles Structure - \list - \li \l{Qt Quick Extras Styles} - \list - \li \l{Qt Quick Extras Styles QML Types}{Styles QMl Types} - \endlist - \endlist -*/ - -/*! - \qmlmodule QtQuick.Extras.Styles 1.0 - \title Qt Quick Extras Styles QML Types - \ingroup qmlmodules - \brief Provides QML types for Qt Quick Extras styles. - - The \l{Qt Quick Extras} module provides a set of QML types for - handling styles. - - Some of the controls allow custom styling similar to widget style sheets. - A styling object is usually a collection of properties that control behavior - and simple delegates that can be replaced with custom QML snippets. - - \code - import QtQuick.Extras.Styles 1.3 - \endcode -*/ diff --git a/src/extras/doc/src/styling-circulargauge.qdoc b/src/extras/doc/src/styling-circulargauge.qdoc deleted file mode 100644 index 9cf94087..00000000 --- a/src/extras/doc/src/styling-circulargauge.qdoc +++ /dev/null @@ -1,145 +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:FDL$ -** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \page styling-circulargauge.html - \title Styling CircularGauge - \brief Tutorial for styling CircularGauge. - \ingroup extrasstyling - - \target styling-circulargauge-needle - \section2 The Needle Component - - The \l {QtQuick.Extras.Styles::CircularGaugeStyle::}{needle} - component is rotated around the gauge to represent the current value. - - Starting from the default style, we'll add a very basic white needle: - - \snippet circulargauge-background-range.qml needle - - \image styling-circulargauge-needle-example.png - - As mentioned in the documentation for \l {QtQuick.Extras.Styles::} - {CircularGaugeStyle}, \c implicitWidth - and \c implicitHeight properties need to be set. This is so that the needle - can be positioned properly. We always scale items by the - \l {QtQuick.Extras.Styles::CircularGaugeStyle::}{outerRadius} - property of the style, ensuring the control resizes gracefully. - - We offset the needle vertically so that its back sits beyond the knob. - - \target styling-circulargauge-foreground - \section2 The Foreground Component - - We've now changed the needle, but the default knob is still there; let's - replace it. The \l {QtQuick.Extras.Styles::CircularGaugeStyle::} - {foreground} component defines the default knob, so we can specify our own by - overriding it (note that we could also set it to \c null if we didn't want a - foreground): - - \snippet circulargauge-background-range.qml foreground - - \image styling-circulargauge-knob-example.png - - Firstly, we create a circle from the Rectangle item by setting the radius to - be half the width (either width or height will work here; they are always - equal in this case). We make it a child of the Item, because the foreground - fills the gauge. We then center it within the Item. - - We set the color of the knob to the same white that we used before. - - \target styling-circulargauge-tickmarkLabel - \section2 The Tickmark Label Component - - Suppose we want to caution the user if the value displayed by the gauge goes - above or below a certain range. We could present this range to the user in - several ways: - - \list A - \li Change the color of the tickmarks depending on \c styleData.value - \li Add an image to the background - \li Draw it with \l {QtQuick::}{Canvas} - \endlist - - We'll choose options 1 and 3, as they are more flexible than using an - image. - - Firstly, let's change the color of the three highest tickmark labels: - - \snippet circulargauge-background-range.qml tickmarkLabel - - \image styling-circulargauge-tickmarkLabel-example.png tickmarkLabel - - We also change the color of the rest of the labels to the same white that - we used for the needle and knob. - - \target styling-circulargauge-tickmark - \section2 The Tickmark Component - - Now let's do the same for the three highest tickmarks: - - \snippet circulargauge-background-range.qml tickmark - - \image styling-circulargauge-tickmark-example.png tickmark - - \target styling-circulargauge-minorTickmark - \section2 The Minor Tickmark Component - - For the minor tickmarks, we'll only show those which are not higher than - \c 80: - - \snippet circulargauge-background-range.qml minorTickmark - - \image styling-circulargauge-minorTickmark-example.png minorTickmark - - This is because we'll draw something between that range in the next section. - - \target styling-circulargauge-background - \section2 The Background Component - - We'll display the range that indicates caution with an orange arc: - - \snippet circulargauge-background-range.qml background - - We define a function to convert degrees to radians, which are the - units used by \l {QtQuick::}{Canvas}. - - Next, we do the drawing of the range using Canvas. We draw an arc between - \c 80 and \c 100, using the - \l {QtQuick.Extras.Styles::CircularGaugeStyle::}{valueToAngle()} - function provided by CircularGaugeStyle. Note that we subtract \c 90 degrees - before converting to radians, as our origin is north and Canvas' is east. - - The finished product: - - \image styling-circulargauge-background-example.png background - - The complete code for this example is as follows: - - \snippet circulargauge-background-range.qml range -*/ - diff --git a/src/extras/doc/src/styling-gauge.qdoc b/src/extras/doc/src/styling-gauge.qdoc deleted file mode 100644 index accdd425..00000000 --- a/src/extras/doc/src/styling-gauge.qdoc +++ /dev/null @@ -1,129 +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:FDL$ -** 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 http://www.qt.io/terms-conditions. For further -** information use the contact form at http://www.qt.io/contact-us. -** -** GNU Free Documentation License Usage -** Alternatively, this file may be used under the terms of the GNU Free -** Documentation License version 1.3 as published by the Free Software -** Foundation and appearing in the file included in the packaging of -** this file. Please review the following information to ensure -** the GNU Free Documentation License version 1.3 requirements -** will be met: http://www.gnu.org/copyleft/fdl.html. -** $QT_END_LICENSE$ -** -****************************************************************************/ - -/*! - \page styling-gauge.html - \title Styling Gauge - \brief Tutorial for styling the Gauge control. - \ingroup extrasstyling - - As GaugeStyle's documentation adequately covers common use cases, this - tutorial will cover a different scenario: one where the gauge's tickmarks - cover the value bar, instead of being aligned to the left or right of it. - - \target styling-gauge-valueBar - \section2 The Value Bar Component - - The \l {QtQuick.Extras.Styles::GaugeStyle::}{valueBar} - component is resized according to the gauge's value; if the value is low, - the bar will be small, and vice versa. - - Starting from the default style, we'll change the color of the value bar to - orange, and increase its width slightly: - - \snippet styling-gauge.qml valueBar - - \image styling-gauge-valueBar.png - - As mentioned in the documentation for GaugeStyle, \c implicitWidth needs to - be set when defining your own value bar. - - \target styling-gauge-foreground - \section2 The Foreground Component - - The \l {QtQuick.Extras.Styles::GaugeStyle::}{foreground} - component covers the full width and height of the value bar, even when the - value bar is not at its highest. By default, the foreground component - provides a "sheen". We'll choose to discard this, and leave it empty - instead: - - \snippet styling-gauge.qml foreground - - \image styling-gauge-foreground.png - - \target styling-gauge-tickmark - \section2 The Tickmark Component - - The \l {QtQuick.Extras.Styles::GaugeStyle::}{tickmark} - component sits to the left or right of the value bar, depending on the - control's \l {Gauge::tickmarkAlignment}{tickmarkAlignment}. In order to - have the tickmarks cover the width of the value bar instead, we need to do - two things: - \list 1 - \li Remove the space the tickmarks previously assumed so that there is - just enough space for margins between the tickmarks and value bar. - \li Position the tickmarks according to the control's orientation and - tickmark alignment. - \endlist - - \snippet styling-gauge.qml tickmark - - In this case we chose \c 8 pixel margins, so we set the \c implicitWidth of - the tickmarks to that. - - We account for every possible orientation and tickmark alignment, something - that is not necessary if the gauge will only ever have one orientation and - alignment. For example, if the gauge will always be of a vertical - orientation and the tickmarks left-aligned, then it is enough to set the - \c x property of the \c Rectangle to the following: - - \code - x: parent.implicitWidth - \endcode - - The value bar is \c 28 pixels wide, so we give the same width to our - tickmarks so that they cover the width of it. - - \image styling-gauge-tickmark.png - - \target styling-gauge-minorTickmark - \section2 The Minor Tickmark Component - - The \l {QtQuick.Extras.Styles::GaugeStyle::}{minorTickmark} - component is almost identical to its larger counterpart, except that its - width does not affect the layout of the gauge's components. We'll do - similar adjustments to the ones in the previous section - the only - difference being the height: - - \snippet styling-gauge.qml minorTickmark - - \image styling-gauge-minorTickmark.png - - \target styling-gauge-font-size - \section2 Adjusting Font Size - - Finally, we increase the \l {Gauge::font}{font} size to \c 15 pixels: - - \snippet styling-gauge.qml font-size - \image styling-gauge-font-size.png - - \target styling-gauge-complete - \section2 Complete Source Code - - \snippet styling-gauge.qml all -*/ - |
