API Documentation

Documentation for developing SailfishOS applications

Materials QML Type

The Materials singleton type provides a set of standard shared Background material definitions. More...

Import Statement: import Sailfish.Silica.Background 1.0

List of all members, including inherited members

Properties

blur : Material
glass : Material
materialNames : stringlist
opaqueColor : Material
translucentColor : Material

Detailed Description

Note: This QML type is under development and is subject to change.

In addition to the materials documented here platform theme specializations may extend this object with their own materials which they will document separately. The list of provided theme materials may be queried from the materialNames property.

Property Documentation

blur : Material

A material which renders an image and an overlay color.

The blur is expected to be used with an already blurred sourceItem image or a FilteredImage with the Filters.glassBlur filter. It does not provide any blurring itself and can be used to display unblurred images with an overlay color too.

To use this with a Background the background must declare a color QML property named color or the ThemeBackground type can be used.

 Background {
     property color color: Theme.rgba("black", 0.2)

     material: GlassMaterial {
     }
 }

See also BlurMaterial.

glass : Material

A material which renders a background wallpaper, pattern and overlay color in the glass theme style.

To use this with a Background the background must declare a color QML property named color or the ThemeBackground type can be used.

 Background {
     property color color: Theme.rgba("black", 0.2)

     material: GlassMaterial {
     }
 }

See also GlassMaterial.

materialNames : stringlist

A list of names of theme background materials.

Each name in this list corresponds to a Material object property of the Materials singleton which can be addressed using object key notation.

 Background {
     material: materials["glass"]
 }

opaqueColor : Material

A material which renders an opaque flat color.

Backgrounds rendered with this material will not blend the background color with items behind them.

A Background item which uses this material must declare a color QML property named color to specify the color of the background.

 Background {
     property color color: Theme.highlightBackgroundColor

     material: Materials.opaqueColor
 }

translucentColor : Material

A material which renders a non-opaque flat color.

Backgrounds rendered with this material will blend the background color with items behind them.