An error occurred while loading the file. Please try again.
-
Alex Blasche authored
- Update Digia's copyright year - Add copyright to files without it - Convert old BSD to new LGPL license for auto test code Change-Id: I47f5c871c436f9c2731b235026434448719cc671 Reviewed-by:Sergio Ahumada <sergio.ahumada@digia.com>
8dad4698
/******************************************************************************** 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