Search for usage in LXR

org::kde::kirigami::templates::private::IconPropertiesGroup Class Reference

Inherits QtQml::QtObject.


color color
real height
string name
var source
real width

Public Member Functions

void fromControlsIcon (icon)

Detailed Description

Group of icon properties.

This is a subset of those used in QQC2, Kirigami.Action still needs the full one as needs 100% api compatibility

Import Statement

import org.kde.kirigami.templates.private

Definition at line 16 of file IconPropertiesGroup.qml.

Property Documentation

◆ color

color org::kde::kirigami::templates::private::IconPropertiesGroup::color

This property holds the icon tint color.

The icon is tinted with the specified color, unless the color is set to "transparent".

Definition at line 39 of file IconPropertiesGroup.qml.

◆ height

real org::kde::kirigami::templates::private::IconPropertiesGroup::height

This property holds the height of the icon.

Definition at line 47 of file IconPropertiesGroup.qml.

◆ name

string org::kde::kirigami::templates::private::IconPropertiesGroup::name

This property holds icon name.

The icon will be loaded from the platform theme. If the icon is found in the theme, it will always be used; even if icon.source is also set. If the icon is not found, icon.source will be used instead.

Definition at line 25 of file IconPropertiesGroup.qml.

◆ source

var org::kde::kirigami::templates::private::IconPropertiesGroup::source

This property holds the icon source.

The icon will be loaded as a regular image.

See also

Definition at line 33 of file IconPropertiesGroup.qml.

◆ width

real org::kde::kirigami::templates::private::IconPropertiesGroup::width

This property holds the width of the icon.

Definition at line 43 of file IconPropertiesGroup.qml.

Member Function Documentation

◆ fromControlsIcon()

void org::kde::kirigami::templates::private::IconPropertiesGroup::fromControlsIcon ( icon )

Bind this icon to all matching properties of a Controls icon group.

This function automatically binds all properties to matching properties of a controls icon group, since we cannot just reuse the Controls icon group.

To use it, you can assign the result to an IconPropertiesGroup, like so: icon: icon.fromControlsIcon(control.icon).

The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri Jul 19 2024 11:52:23 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.