org::kde::kirigami::BasicListItem

Properties | |
alias | _basicDefault |
bool | bold |
bool | fadeContent |
var | icon |
alias | iconColor |
alias | iconSelected |
alias | iconSize |
alias | label |
alias | labelItem |
Item | leading |
bool | leadingFillVertically |
real | leadingPadding |
alias | reserveSpaceForIcon |
alias | reserveSpaceForLabel |
bool | reserveSpaceForSubtitle |
alias | subtitle |
alias | subtitleItem |
alias | textSpacing |
bool | toolTipVisible |
Item | trailing |
bool | trailingFillVertically |
real | trailingPadding |
![]() | |
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
A BasicListItem provides a simple list item design that can handle the most common list item usecases.
- Warning
- This will be reworked into a layout to be used inside a delegate.
Definition at line 21 of file BasicListItem.qml.
Property Documentation
◆ _basicDefault
|
read |
- Remarks
- This is the default property
Definition at line 224 of file BasicListItem.qml.
◆ bold
|
read |
This property sets whether list item's text should render in bold.
default: false
- Since
- KDE Frameworks 5.71
- org.kde.kirigami 2.13
Definition at line 101 of file BasicListItem.qml.
◆ fadeContent
|
read |
This property holds sets whether to make the icon and labels have a disabled look.
This can be used to tweak whether the content elements are visually active while preserving an active appearance for any leading or trailing items.
default: false
- Since
- KDE Frameworks 5.83
- org.kde.kirigami 2.15
Definition at line 202 of file BasicListItem.qml.
◆ icon
|
read |
The icon that will render on this list item.
This can either be an icon name, a URL, or an object with the following properties:
If the type of the icon is a string containing an icon name, the icon will be looked up from the platform icon theme.
Using an icon object allows you to specify more granular attributes of the icon, such as its color and dimensions.
If the icon is a URL, the icon will be attempted to be loaded from the given URL.
Definition at line 128 of file BasicListItem.qml.
◆ iconColor
|
read |
This property holds the color of the icon.
If the icon's original colors should be left intact, set this to the default value, "transparent". Note that this colour will only be applied if the icon can be recoloured, (e.g. you can use Kirigami.Theme.foregroundColor to change the icon's colour.)
- Since
- org.kde.kirigami 2.7
Definition at line 147 of file BasicListItem.qml.
◆ iconSelected
|
read |
This property sets whether or not the icon has a "selected" appearance.
Can be used to override the icon coloration if the list item's background and text are also being overridden, to ensure that the icon never becomes invisible.
- Since
- KDE Frameworks 5.91
- org.kde.kirigami 2.19
Definition at line 158 of file BasicListItem.qml.
◆ iconSize
|
read |
This property sets the size at which the icon will render.
This will not affect icon lookup, unlike the icon group's width and height properties, which will.
- Since
- org.kde.kirigami 2.5
Definition at line 137 of file BasicListItem.qml.
◆ label
|
read |
This property holds the text of this list item's label.
If a subtitle is provided, the label will behave as a title and will be styled accordingly. Every list item should have a label.
Definition at line 32 of file BasicListItem.qml.
◆ labelItem
This property holds the label item, for accessing the usual QtQuick.Text properties.
- Since
- KDE Frameworks 5.84
- org.kde.kirigami 2.16
Definition at line 209 of file BasicListItem.qml.
◆ leading
|
read |
This property holds an item that will be displayed before the title and subtitle.
- Note
- The leading item is allowed to expand infinitely horizontally, and should be bounded by the user.
- Since
- org.kde.kirigami 2.15
Definition at line 44 of file BasicListItem.qml.
◆ leadingFillVertically
|
read |
This property sets whether or not to stretch the leading item to fit all available vertical space.
If false, you will be responsible for setting a height for the item or ensuring that its default height works.
default: true
- Warning
- This property will likely be removed in KF6
- Since
- KDE Frameworks 5.83
- org.kde.kirigami 2.15
Definition at line 65 of file BasicListItem.qml.
◆ leadingPadding
|
read |
This property holds the padding after the leading item.
- Since
- org.kde.kirigami 2.15
Definition at line 49 of file BasicListItem.qml.
◆ reserveSpaceForIcon
|
read |
This property sets whether or not to reserve space for the icon, even if there is no icon.
Definition at line 164 of file BasicListItem.qml.
◆ reserveSpaceForLabel
|
read |
This property sets whether or not the label of the list item should fill width.
Setting this to false
is useful if you have other items in the list item that should fill width instead of the label.
Definition at line 173 of file BasicListItem.qml.
◆ reserveSpaceForSubtitle
|
read |
This property holds whether the list item's height should account for the presence of a subtitle.
default: false
- Since
- KDE Frameworks 5.77
- org.kde.kirigami 2.15
Definition at line 183 of file BasicListItem.qml.
◆ subtitle
|
read |
This property holds an optional subtitle that can appear under the label.
- Since
- KDE Frameworks 5.70
- org.kde.kirigami 2.12
Definition at line 38 of file BasicListItem.qml.
◆ subtitleItem
This property holds the subtitle item, for accessing the usual QtQuick.Text properties.
- Since
- KDE Frameworks 5.84
- org.kde.kirigami 2.16
Definition at line 216 of file BasicListItem.qml.
◆ textSpacing
|
read |
This property holds the spacing between the label row and subtitle row.
- Since
- KDE Frameworks 5.83
- org.kde.kirigami 2.15
Definition at line 190 of file BasicListItem.qml.
◆ toolTipVisible
|
read |
This property holds whether the tooltip of the subtitle should be visible.
- Since
- 5.107
Definition at line 221 of file BasicListItem.qml.
◆ trailing
|
read |
This property holds an item that will be displayed after the title and subtitle.
- Note
- The trailing item is allowed to expand infinitely horizontally, and should be bounded by the user.
- Since
- org.kde.kirigami 2.15
Definition at line 71 of file BasicListItem.qml.
◆ trailingFillVertically
|
read |
This propery sets whether or not to stretch the trailing item to fit all available vertical space.
If false, you will be responsible for setting a height for the item or ensuring that its default height works.
default: true
- Warning
- This property will likely be removed in KF6
- Since
- KDE Frameworks 5.83
- org.kde.kirigami 2.15
Definition at line 92 of file BasicListItem.qml.
◆ trailingPadding
|
read |
This property holds the padding before the trailing item.
- Since
- org.kde.kirigami 2.15
Definition at line 76 of file BasicListItem.qml.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Tue Dec 5 2023 04:08:21 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.