An error occurred while loading the file. Please try again.
-
Jens Bache-Wiig authored
Change-Id: I1fabb4efcc931f12f0a65ac5c66e6e085108269b Reviewed-by:J-P Nurmi <jpnurmi@digia.com>
5857ea03
/******************************************************************************** Copyright (C) 2012 Nokia Corporation and/or its subsidiary(-ies).** Contact: http://www.qt-project.org/**** This file is part of the QtQml module of the Qt Toolkit.**** $QT_BEGIN_LICENSE:LGPL$** GNU Lesser General Public License Usage** This file may be used under the terms of the GNU Lesser General Public** License version 2.1 as published by the Free Software Foundation and** appearing in the file LICENSE.LGPL included in the packaging of this** file. Please review the following information to ensure the GNU Lesser** General Public License version 2.1 requirements will be met:** http://www.gnu.org/licenses/old-licenses/lgpl-2.1.html.**** In addition, as a special exception, Nokia gives you certain additional** rights. These rights are described in the Nokia Qt LGPL Exception** version 1.1, included in the file LGPL_EXCEPTION.txt in this package.**** GNU General Public License Usage** Alternatively, this file may be used under the terms of the GNU General** Public License version 3.0 as published by the Free Software Foundation** and appearing in the file LICENSE.GPL included in the packaging of this** file. Please review the following information to ensure the GNU General** Public License version 3.0 requirements will be met:** http://www.gnu.org/copyleft/gpl.html.**** Other Usage** Alternatively, this file may be used in accordance with the terms and** conditions contained in a signed written agreement between you and Nokia.************** $QT_END_LICENSE$******************************************************************************/#include "qquickborderimage_p.h"#include "qquickborderimage_p_p.h"#include "qquickninepatchnode_p.h"#include <QtQml/qqmlinfo.h>#include <QtQml/qqmlfile.h>#include <QtQml/qqmlengine.h>#include <QtNetwork/qnetworkreply.h>#include <QtCore/qfile.h>#include <private/qqmlglobal_p.h>QT_BEGIN_NAMESPACE/*! \qmlclass BorderImage QQuickBorderImage \inqmlmodule QtQuick 2 \brief For specifying an image that can be used as a border \inherits Item \ingroup qtquick-visual The BorderImage element is used to create borders out of images by scaling or tiling parts of each image. A BorderImage element breaks a source image, specified using the \l url property, into 9 regions, as shown below: \image declarative-scalegrid.png7172737475767778798081828384858687888990919293949596979899100101102103104105106107108109110111112113114115116117118119120121122123124125126127128129130131132133134135136137138139140
When the image is scaled, regions of the source image are scaled or tiled to
create the displayed border image in the following way:
\list
\li The corners (regions 1, 3, 7, and 9) are not scaled at all.
\li Regions 2 and 8 are scaled according to
\l{BorderImage::horizontalTileMode}{horizontalTileMode}.
\li Regions 4 and 6 are scaled according to
\l{BorderImage::verticalTileMode}{verticalTileMode}.
\li The middle (region 5) is scaled according to both
\l{BorderImage::horizontalTileMode}{horizontalTileMode} and
\l{BorderImage::verticalTileMode}{verticalTileMode}.
\endlist
The regions of the image are defined using the \l border property group, which
describes the distance from each edge of the source image to use as a border.
\section1 Example Usage
The following examples show the effects of the different modes on an image.
Guide lines are overlaid onto the image to show the different regions of the
image as described above.
\beginfloatleft
\image qml-borderimage-normal-image.png
\endfloat
An unscaled image is displayed using an Image element. The \l border property is
used to determine the parts of the image that will lie inside the unscaled corner
areas and the parts that will be stretched horizontally and vertically.
\snippet qml/borderimage/normal-image.qml normal image
\clearfloat
\beginfloatleft
\image qml-borderimage-scaled.png
\endfloat
A BorderImage element is used to display the image, and it is given a size that is
larger than the original image. Since the \l horizontalTileMode property is set to
\l{BorderImage::horizontalTileMode}{BorderImage.Stretch}, the parts of image in
regions 2 and 8 are stretched horizontally. Since the \l verticalTileMode property
is set to \l{BorderImage::verticalTileMode}{BorderImage.Stretch}, the parts of image
in regions 4 and 6 are stretched vertically.
\snippet qml/borderimage/borderimage-scaled.qml scaled border image
\clearfloat
\beginfloatleft
\image qml-borderimage-tiled.png
\endfloat
Again, a large BorderImage element is used to display the image. With the
\l horizontalTileMode property set to \l{BorderImage::horizontalTileMode}{BorderImage.Repeat},
the parts of image in regions 2 and 8 are tiled so that they fill the space at the
top and bottom of the element. Similarly, the \l verticalTileMode property is set to
\l{BorderImage::verticalTileMode}{BorderImage.Repeat}, the parts of image in regions
4 and 6 are tiled so that they fill the space at the left and right of the element.
\snippet qml/borderimage/borderimage-tiled.qml tiled border image
\clearfloat
In some situations, the width of regions 2 and 8 may not be an exact multiple of the width
of the corresponding regions in the source image. Similarly, the height of regions 4 and 6
may not be an exact multiple of the height of the corresponding regions. It can be useful
to use \l{BorderImage::horizontalTileMode}{BorderImage.Round} instead of
\l{BorderImage::horizontalTileMode}{BorderImage.Repeat} in cases like these.
The \l{declarative/imageelements/borderimage}{BorderImage example} shows how a BorderImage
141142143144145146147148149150151152153154155156157158159160161162163164165166167168169170171172173174175176177178179180181182183184185186187188189190191192193194195196197198199200201202203204205206207208209210
can be used to simulate a shadow effect on a rectangular item.
\section1 Quality and Performance
By default, any scaled regions of the image are rendered without smoothing to improve
rendering speed. Setting the \l smooth property improves rendering quality of scaled
regions, but may slow down rendering.
The source image may not be loaded instantaneously, depending on its original location.
Loading progress can be monitored with the \l progress property.
\sa Image, AnimatedImage
*/
/*!
\qmlproperty bool QtQuick2::BorderImage::asynchronous
Specifies that images on the local filesystem should be loaded
asynchronously in a separate thread. The default value is
false, causing the user interface thread to block while the
image is loaded. Setting \a asynchronous to true is useful where
maintaining a responsive user interface is more desirable
than having images immediately visible.
Note that this property is only valid for images read from the
local filesystem. Images loaded via a network resource (e.g. HTTP)
are always loaded asynchronously.
*/
QQuickBorderImage::QQuickBorderImage(QQuickItem *parent)
: QQuickImageBase(*(new QQuickBorderImagePrivate), parent)
{
}
QQuickBorderImage::~QQuickBorderImage()
{
Q_D(QQuickBorderImage);
if (d->sciReply)
d->sciReply->deleteLater();
}
/*!
\qmlproperty enumeration QtQuick2::BorderImage::status
This property describes the status of image loading. It can be one of:
\list
\li BorderImage.Null - no image has been set
\li BorderImage.Ready - the image has been loaded
\li BorderImage.Loading - the image is currently being loaded
\li BorderImage.Error - an error occurred while loading the image
\endlist
\sa progress
*/
/*!
\qmlproperty real QtQuick2::BorderImage::progress
This property holds the progress of image loading, from 0.0 (nothing loaded)
to 1.0 (finished).
\sa status
*/
/*!
\qmlproperty bool QtQuick2::BorderImage::smooth
Set this property if you want the image to be smoothly filtered when scaled or
transformed. Smooth filtering gives better visual quality, but is slower. If
the image is displayed at its natural size, this property has no visual or
211212213214215216217218219220221222223224225226227228229230231232233234235236237238239240241242243244245246247248249250251252253254255256257258259260261262263264265266267268269270271272273274275276277278279280
performance effect.
By default, this property is set to false.
\note Generally scaling artifacts are only visible if the image is stationary on
the screen. A common pattern when animating an image is to disable smooth
filtering at the beginning of the animation and enable it at the conclusion.
*/
/*!
\qmlproperty bool QtQuick2::BorderImage::cache
Specifies whether the image should be cached. The default value is
true. Setting \a cache to false is useful when dealing with large images,
to make sure that they aren't cached at the expense of small 'ui element' images.
*/
/*!
\qmlproperty bool QtQuick2::BorderImage::mirror
This property holds whether the image should be horizontally inverted
(effectively displaying a mirrored image).
The default value is false.
*/
/*!
\qmlproperty url QtQuick2::BorderImage::source
This property holds the URL that refers to the source image.
BorderImage can handle any image format supported by Qt, loaded from any
URL scheme supported by Qt.
This property can also be used to refer to .sci files, which are
written in a QML-specific, text-based format that specifies the
borders, the image file and the tile rules for a given border image.
The following .sci file sets the borders to 10 on each side for the
image \c picture.png:
\code
border.left: 10
border.top: 10
border.bottom: 10
border.right: 10
source: "picture.png"
\endcode
The URL may be absolute, or relative to the URL of the component.
\sa QQuickImageProvider
*/
/*!
\qmlproperty QSize QtQuick2::BorderImage::sourceSize
This property holds the actual width and height of the loaded image.
In BorderImage, this property is read-only.
\sa Image::sourceSize
*/
void QQuickBorderImage::setSource(const QUrl &url)
{
Q_D(QQuickBorderImage);
if (url == d->url)
return;