org::kde::kirigami::templates::SwipeListItem Class Reference

Inherits QtQuick.Templates.ItemDelegate, and ItemDelegate.

Properties
alias	_default
list< Action >	actions
alias	actionsVisible
color	activeBackgroundColor
color	activeTextColor
color	alternateBackgroundColor
bool	alternatingBackground
color	backgroundColor
alias	containsMouse
bool	sectionDelegate
bool	separatorVisible
alias	supportsMouseEvents
color	textColor

Detailed Description

An item delegate Intended to support extra actions obtainable by uncovering them by dragging away the item with the handle This acts as a container for normal list items.

Since

2.2 Any subclass of AbstractListItem can be assigned as the contentItem property.

ListView {
    model: myModel
    delegate: SwipeListItem {
        QQC2.Label {
            text: model.text
        }
        actions: [
             Action {
                 iconName: "document-decrypt"
                 onTriggered: print("Action 1 clicked")
             },
             Action {
                 iconName: model.action2Icon
                 onTriggered: //do something
             }
        ]
    }

}

Definition at line 55 of file controls/templates/SwipeListItem.qml.

Property Documentation

alias org::kde::kirigami::templates::SwipeListItem::_default

Remarks

This is the default property

Definition at line 143 of file controls/templates/SwipeListItem.qml.

list<Action> org::kde::kirigami::templates::SwipeListItem::actions

actions: list<Action> Defines the actions for the list item: at most 4 buttons will contain the actions for the item, that can be revealed by sliding away the list item.

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

alias org::kde::kirigami::templates::SwipeListItem::actionsVisible

actionsVisible: bool True if it's possible to see and access the item actions.

Actions should go completely out of the way for instance during the editing of an item.

Since

2.5

Definition at line 98 of file controls/templates/SwipeListItem.qml.

color org::kde::kirigami::templates::SwipeListItem::activeBackgroundColor

activeBackgroundColor: color Color for the background of the item when pressed or selected It is advised to leave the default value (Theme.highlightColor)

Definition at line 140 of file controls/templates/SwipeListItem.qml.

color org::kde::kirigami::templates::SwipeListItem::activeTextColor

activeTextColor: color Color for the text in the item when pressed or selected It is advised to leave the default value (Theme.highlightedTextColor)

Note: if custom text elements are inserted in an AbstractListItem, their color property will have to be manually bound with this property

Definition at line 134 of file controls/templates/SwipeListItem.qml.

color org::kde::kirigami::templates::SwipeListItem::alternateBackgroundColor

alternateBackgroundColor: color The background color to use if alternatingBackground is true.

It is advised to leave the default.

Since

2.7

Definition at line 125 of file controls/templates/SwipeListItem.qml.

bool org::kde::kirigami::templates::SwipeListItem::alternatingBackground

alternatingBackground: bool If true the background of the list items will be alternating between two colors, helping readability with multiple column views.

Use it only when implementing a view which shows data visually in multiple columns @ since 2.7

Definition at line 78 of file controls/templates/SwipeListItem.qml.

color org::kde::kirigami::templates::SwipeListItem::backgroundColor

backgroundColor: color Color for the background of the item

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

alias org::kde::kirigami::templates::SwipeListItem::containsMouse

containsMouse: bool True when the user hover the mouse over the list item NOTE: on mobile touch devices this will be true only when pressed is also true

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

bool org::kde::kirigami::templates::SwipeListItem::sectionDelegate

sectionDelegate: bool If true the item will be a delegate for a section, so will look like a "title" for the items under it.

Definition at line 84 of file controls/templates/SwipeListItem.qml.

bool org::kde::kirigami::templates::SwipeListItem::separatorVisible

separatorVisible: bool True if the separator between items is visible default: true

Definition at line 90 of file controls/templates/SwipeListItem.qml.

alias org::kde::kirigami::templates::SwipeListItem::supportsMouseEvents

supportsMouseEvents: bool Holds if the item emits signals related to mouse interaction.

TODO: remove The default value is false.

Definition at line 64 of file controls/templates/SwipeListItem.qml.

color org::kde::kirigami::templates::SwipeListItem::textColor

textColor: color Color for the text in the item

Note: if custom text elements are inserted in an AbstractListItem, their color property will have to be manually bound with this property

Definition at line 113 of file controls/templates/SwipeListItem.qml.

---

The documentation for this class was generated from the following file:

• controls/templates/SwipeListItem.qml