diff options
author | Miikka Heikkinen <miikka.heikkinen@digia.com> | 2013-09-25 14:25:22 +0300 |
---|---|---|
committer | Miikka Heikkinen <miikka.heikkinen@digia.com> | 2013-09-26 07:42:37 +0300 |
commit | bb0e49c6bc7e4e650fc84366ff51ee47c8e5c530 (patch) | |
tree | 9d171a1dc51cd690e7edcd4cf7e4da442dc01ba2 /src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc | |
parent | d44ecd0b27e591429893e4b870713e245a3c46f9 (diff) |
Implement ColorGradient for qml
Reimplementation of qml's Gradient type, which unfortunately cannot be
used by 3rd party modules, as the implementation classes are private.
Task-number: QTRD-2328
Change-Id: Ib984b07f6771d26a9e37fd5f78016b7ba0bd7ce0
Reviewed-by: Tomi Korpipää <tomi.korpipaa@digia.com>
Diffstat (limited to 'src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc')
-rw-r--r-- | src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc | 73 |
1 files changed, 73 insertions, 0 deletions
diff --git a/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc new file mode 100644 index 00000000..98b29c87 --- /dev/null +++ b/src/datavisualization/doc/src/qtdatavisualization-qml-colorgradient.qdoc @@ -0,0 +1,73 @@ +/**************************************************************************** +** +** Copyright (C) 2013 Digia Plc +** All rights reserved. +** For any questions to Digia, please use contact form at http://qt.digia.com +** +** This file is part of the QtDataVisualization module. +** +** Licensees holding valid Qt Enterprise licenses may use this file in +** accordance with the Qt Enterprise License Agreement provided with the +** Software or, alternatively, in accordance with the terms contained in +** a written agreement between you and Digia. +** +** If you have questions regarding the use of this file, please use +** contact form at http://qt.digia.com +** +****************************************************************************/ + +/*! + \qmltype ColorGradientStop + + Defines the color at a position in a ColorGradient. + + \sa ColorGradient +*/ + +/*! + \qmlproperty real ColorGradientStop::position + + The position property describes the position of this gradient stop. + + The default position is 0.0. + + \sa ColorGradient +*/ + +/*! + \qmlproperty color ColorGradientStop::color + + The color property describes the color color of this gradient stop. + + The default color is black. + + \sa ColorGradient +*/ + +/*! + \qmltype ColorGradient + + A gradient is defined by two or more colors, which will be blended seamlessly. + + The colors are specified as a set of ColorGradientStop child items, each of + which defines a position on the gradient from 0.0 to 1.0 and a color. + The position of each ColorGradientStop is defined by setting its + \l{ColorGradientStop::}{position} property; its color is defined using its + \l{ColorGradientStop::}{color} property. + + A gradient without any gradient stops falls back to QLinearGradient default, + which is black at 0.0 and white at 1.0. + + \sa ColorGradientStop +*/ + +/*! + \qmlproperty list<ColorGradientStop> ColorGradient::stops + \default + + This property holds the gradient stops describing the gradient. + + By default, this property contains an empty list. + + To set the gradient stops, define them as children of the ColorGradient. +*/ |