Icon QML Type

The Icon type represents an icon image source which can have multiple sizes. More...

• List of all members, including inherited members

Properties

• icon : QPlaceIcon
• parameters : Object
• plugin : Plugin

Methods

• url url(size size)

Detailed Description

The Icon type can be used in conjunction with an Image type to display an icon. The url() function is used to construct an icon URL of a requested size, the icon which most closely matches the requested size is returned.

The Icon type also has a parameters map which is a set of key value pairs. The precise keys to use depend on the plugin being used. The parameters map is used by the Plugin to determine which URL to return.

In the case where an icon can only possibly have one image URL, the parameter key of "singleUrl" can be used with a QUrl value. Any Icon with this parameter will always return the specified URL regardless of the requested icon size and not defer to any Plugin.

The following code shows how to display a 64x64 pixel icon:

import QtQuick 2.0
import QtPositioning 5.2
import QtLocation 5.3

Image {
    source: icon.url(Qt.size(64, 64))
}

Alternatively, a default sized icon can be specified like so:

    source: icon.url()

Property Documentation

Method Documentation