org::kde::kirigami::templates::AbstractListItem

Search for usage in LXR

org::kde::kirigami::templates::AbstractListItem Class Reference
Inheritance diagram for org::kde::kirigami::templates::AbstractListItem:

Properties

alias _default
 
QQC2 Action
 
color activeBackgroundColor
 
color activeTextColor
 
color alternateBackgroundColor
 
bool alternatingBackground
 
color backgroundColor
 
alias containsMouse
 
bool sectionDelegate
 
bool separatorVisible
 
bool supportsMouseEvents
 
color textColor
 

Detailed Description

An item delegate for the primitive ListView component.

Since
2.2

It's intended to make all listviews look coherent.

Definition at line 21 of file controls/templates/AbstractListItem.qml.

Property Documentation

◆ _default

alias org::kde::kirigami::templates::AbstractListItem::_default
read
Remarks
This is the default property

Definition at line 118 of file controls/templates/AbstractListItem.qml.

◆ activeBackgroundColor

color org::kde::kirigami::templates::AbstractListItem::activeBackgroundColor
read

This property holds the color of the background when the item is pressed or selected.

It is advised to use the default value. default: Kirigami.Theme.highlightColor

Definition at line 95 of file controls/templates/AbstractListItem.qml.

◆ activeTextColor

color org::kde::kirigami::templates::AbstractListItem::activeTextColor
read

This property holds the color of the text when the item is pressed or selected.

It is advised to use the default value. default: Kirigami.Theme.highlightedTextColor

If custom text elements are inserted in an AbstractListItem, their color will have to be manually set with this property.

Definition at line 115 of file controls/templates/AbstractListItem.qml.

◆ alternateBackgroundColor

color org::kde::kirigami::templates::AbstractListItem::alternateBackgroundColor
read

This property holds the background color to be used when background alternating is enabled.

It is advised to use the default value. default: Kirigami.Theme.alternateBackgroundColor

Since
2.7

Definition at line 87 of file controls/templates/AbstractListItem.qml.

◆ alternatingBackground

bool org::kde::kirigami::templates::AbstractListItem::alternatingBackground
read

This property sets whether instances of this list item will alternate between two colors, helping readability.

It is suggested to use this only when implementing a view with multiple columns.

default: false

Since
2.7

Definition at line 52 of file controls/templates/AbstractListItem.qml.

◆ backgroundColor

color org::kde::kirigami::templates::AbstractListItem::backgroundColor
read

This property holds list item's background color.

It is advised to use the default value. default: "transparent"

Definition at line 77 of file controls/templates/AbstractListItem.qml.

◆ containsMouse

bool AbstractListItem::containsMouse
read

This property tells whether the cursor is currently hovering over the item.

On mobile touch devices, this will be true only when pressed.

See also
QtQuick.Templates.ItemDelegate::hovered
Deprecated:
This will be removed in KF6; use the hovered property instead.

Definition at line 41 of file controls/templates/AbstractListItem.qml.

◆ sectionDelegate

bool org::kde::kirigami::templates::AbstractListItem::sectionDelegate
read

This property sets whether this item is a section delegate.

Setting this to true will make the list item look like a "title" for items under it.

default: false

See also
ListSectionHeader

Definition at line 62 of file controls/templates/AbstractListItem.qml.

◆ separatorVisible

bool org::kde::kirigami::templates::AbstractListItem::separatorVisible
read

This property sets whether the separator is visible.

The separator is a line between this and the item under it.

default: false

Definition at line 70 of file controls/templates/AbstractListItem.qml.

◆ supportsMouseEvents

bool org::kde::kirigami::templates::AbstractListItem::supportsMouseEvents
read

This property sets whether the item should emit signals related to mouse interaction.

default: true

Deprecated:
This will be removed in KF6.

Definition at line 31 of file controls/templates/AbstractListItem.qml.

◆ textColor

color org::kde::kirigami::templates::AbstractListItem::textColor
read

This property holds the color of the text in the item.

It is advised to use the default value. default: Kirigami.Theme.textColor

If custom text elements are inserted in an AbstractListItem, their color will have to be manually set with this property.

Definition at line 105 of file controls/templates/AbstractListItem.qml.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Feb 7 2023 04:14:25 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.