QML BorderImage Element

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 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 asynchonously.

The 4 border lines (2 horizontal and 2 vertical) break the image into 9 sections, as shown below:

Each border line (left, right, top, and bottom) specifies an offset in pixels from the respective edge of the source image. By default, each border line has a value of 0.

For example, the following definition sets the bottom line 10 pixels up from the bottom of the image:

 BorderImage {
     border.bottom: 10
     // ...
 }

The border lines can also be specified using a .sci file.

Specifies whether the image should be cached. The default value is true. Setting 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.

This property group was introduced in QtQuick 1.1.

This property describes how to repeat or stretch the middle parts of the border image.

• BorderImage.Stretch - Scales the image to fit to the available area.
• BorderImage.Repeat - Tile the image until there is no more space. May crop the last image.
• BorderImage.Round - Like Repeat, but scales the images down to ensure that the last image is not cropped.

The default tile mode for each property is BorderImage.Stretch.

This property holds whether the image should be horizontally inverted (effectively displaying a mirrored image).

The default value is false.

This property group was introduced in QtQuick 1.1.

This property holds the progress of image loading, from 0.0 (nothing loaded) to 1.0 (finished).

See also status.

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 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.

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 picture.png:

 border.left: 10
 border.top: 10
 border.bottom: 10
 border.right: 10
 source: "picture.png"

The URL may be absolute, or relative to the URL of the component.

See also QDeclarativeImageProvider.

This property holds the actual width and height of the loaded image.

In BorderImage, this property is read-only.

See also Image::sourceSize.

This property describes the status of image loading. It can be one of:

• BorderImage.Null - no image has been set
• BorderImage.Ready - the image has been loaded
• BorderImage.Loading - the image is currently being loaded
• BorderImage.Error - an error occurred while loading the image

See also progress.