summaryrefslogtreecommitdiffstats
diff options
context:
space:
mode:
authorMichael Brasser <michael.brasser@nokia.com>2009-04-23 23:49:49 (GMT)
committerMichael Brasser <michael.brasser@nokia.com>2009-04-23 23:49:49 (GMT)
commit435acb8edc48c0e13606a27392d4dc72952b19ca (patch)
tree23c5de34103dfaf1ac3d0f2aa5828d30ab017502
parentdb815819dae525c64575de38b92afa4cf092ce06 (diff)
downloadQt-435acb8edc48c0e13606a27392d4dc72952b19ca.zip
Qt-435acb8edc48c0e13606a27392d4dc72952b19ca.tar.gz
Qt-435acb8edc48c0e13606a27392d4dc72952b19ca.tar.bz2
Expose basic BlendedImage docs.
-rw-r--r--doc/src/declarative/elements.qdoc2
-rw-r--r--src/declarative/fx/qfxblendedimage.cpp29
2 files changed, 23 insertions, 8 deletions
diff --git a/doc/src/declarative/elements.qdoc b/doc/src/declarative/elements.qdoc
index afc3726..90a65c1 100644
--- a/doc/src/declarative/elements.qdoc
+++ b/doc/src/declarative/elements.qdoc
@@ -32,6 +32,7 @@ The following table lists the Qml elements provided by the Qt Declarative module
\o \l SequentialAnimation
\o \l ParallelAnimation
\o \l SetPropertyAction
+\o \l ParentChangeAction
\o \l Transition
\o \l Behaviour
\o \l Follow
@@ -67,6 +68,7 @@ The following table lists the Qml elements provided by the Qt Declarative module
\o \l MouseRegion
\o \l KeyActions
\o \l AnimatedImage
+\o \l BlendedImage
\endlist
\o
diff --git a/src/declarative/fx/qfxblendedimage.cpp b/src/declarative/fx/qfxblendedimage.cpp
index 9a3bb72..b5d9a9a 100644
--- a/src/declarative/fx/qfxblendedimage.cpp
+++ b/src/declarative/fx/qfxblendedimage.cpp
@@ -49,12 +49,24 @@
QT_BEGIN_NAMESPACE
/*!
+ \qmlclass BlendedImage
+ \brief The BlendedImage elements blends two different images depending on a blend ratio.
+
+ This element can be used to simulate blur on slow devices by setting secondaryUrl with
+ a pre-rendered blurred version of primaryUrl.
+
+ Note that this class will only work under OpenGL. On the software canvas it will display
+ only the primary image unless the blend is > 0.75, in which case it will display only the
+ secondary image.
+*/
+
+/*!
\internal
\class QFxBlendedImage
\brief The QFxBlendedImage blends two different images depending on a blend ratio.
- This class can be used to simulate blur on slow devices by setting secondaryFile with
- a pre-rendered blurred version of primaryFile.
+ This class can be used to simulate blur on slow devices by setting secondaryUrl with
+ a pre-rendered blurred version of primaryUrl.
Note that this class will only work under OpenGL. On the software canvas it will display
only the primary image unless the blend is > 0.75, in which case it will display only the
@@ -69,8 +81,8 @@ QFxBlendedImage::QFxBlendedImage(QFxItem *parent)
}
/*!
- \property QFxBlendedImage::primaryUrl
- \brief the URL of the first image to be displayed in this item.
+ \qmlproperty string BlendedImage::primaryUrl
+ The URL of the first image to be displayed in this item.
*/
QString QFxBlendedImage::primaryUrl() const
{
@@ -97,8 +109,8 @@ void QFxBlendedImage::setPrimaryUrl(const QString &url)
}
/*!
- \property QFxBlendedImage::secondaryUrl
- \brief the URL of the second image to be displayed in this item.
+ \qmlproperty string BlendedImage::secondaryUrl
+ The URL of the second image to be displayed in this item.
*/
QString QFxBlendedImage::secondaryUrl() const
{
@@ -125,8 +137,8 @@ void QFxBlendedImage::setSecondaryUrl(const QString &url)
}
/*!
- \property QFxBlendedImage::blend
- \brief the ratio used to blend the two images.
+ \qmlproperty real BlendedImage::blend
+ The ratio used to blend the two images.
If blend has a value of 0, only the first image will be displayed.
If blend has a value of 1, only the second image will be displayed.
@@ -246,4 +258,5 @@ void QFxBlendedImage::paintGLContents(GLPainter &p)
#endif
QML_DEFINE_TYPE(QFxBlendedImage,BlendedImage);
+
QT_END_NAMESPACE