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

Inherits SwipeListItem, QtQuick.Item, Item, QtQuick.Item, and SwipeListItem.

Properties
list< Action >	actions
color	activeBackgroundColor
color	activeTextColor
Item	background
color	backgroundColor
bool	checked
alias	containsMouse
Item	contentItem
real	position
alias	pressed
bool	sectionDelegate
bool	separatorVisible
alias	supportsMouseEvents
color	textColor

Signals
void	clicked ()
void	pressAndHold ()

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.

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

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

}

Definition at line 50 of file controls/SwipeListItem.qml.

Property Documentation

list<Action> org::kde::kirigami::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 126 of file controls/templates/SwipeListItem.qml.

color org::kde::kirigami::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 171 of file controls/templates/SwipeListItem.qml.

color org::kde::kirigami::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 proprty will ahve to be manually binded with this property

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

Item org::kde::kirigami::SwipeListItem::background

background: Item This property holds the background item.

Note: If the background item has no explicit size specified, it automatically follows the control's size. In most cases, there is no need to specify width or height for a background item.

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

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

backgroundColor: color Color for the background of the item

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

bool org::kde::kirigami::SwipeListItem::checked

checked: bool If true makes the list item look as checked or pressed.

It has to be set from the code, it won't change by itself.

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

alias org::kde::kirigami::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 107 of file controls/templates/SwipeListItem.qml.

Item org::kde::kirigami::SwipeListItem::contentItem

contentItem: Item This property holds the visual content item.

Note: The content item is automatically resized inside the padding of the control.

Remarks

This is the default property

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

real org::kde::kirigami::SwipeListItem::position

position: real This property holds the position of the dragged list item relative to its final destination (just like the Drawer).

That is, the position will be 0 when the list item is fully closed, and 1 when fully open.

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

alias org::kde::kirigami::SwipeListItem::pressed

pressed: bool True when the user is pressing the mouse over the list item and supportsMouseEvents is set to true

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

bool org::kde::kirigami::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 113 of file controls/templates/SwipeListItem.qml.

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

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

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

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

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

TODO: remove The default value is false.

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

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

textColor: color Color for the text in the item

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

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

Member Function Documentation

void org::kde::kirigami::SwipeListItem::clicked ( )

signal

clicked: signal This signal is emitted when there is a click.

This is disabled by default, set enabled to true to use it.

See Also

enabled

void org::kde::kirigami::SwipeListItem::pressAndHold ( )

signal

pressAndHold: signal The user pressed the item with the mouse and didn't release it for a certain amount of time.

This is disabled by default, set enabled to true to use it.

See Also

enabled

---

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

• controls/SwipeListItem.qml