org::kde::kirigami::BasicListItem

Properties | |
alias | _basicDefault |
bool | bold |
bool | fadeContent |
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 |
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.
Definition at line 19 of file BasicListItem.qml.
Property Documentation
◆ _basicDefault
|
read |
- Remarks
- This is the default property
Definition at line 192 of file BasicListItem.qml.
◆ bold
|
read |
This property sets whether list item's text should render in bold.
default: false
- Since
- 5.71
- org.kde.kirigami 2.13
Definition at line 99 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
- 5.83
- org.kde.kirigami 2.15
Definition at line 173 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
- 2.7
Definition at line 118 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
- 5.91
- org.kde.kirigami 2.19
Definition at line 129 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
- 2.5
Definition at line 108 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 30 of file BasicListItem.qml.
◆ labelItem
|
read |
This property holds the label item, for accessing the usual Text properties.
- Since
- 5.84
- org.kde.kirigami 2.16
Definition at line 180 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 42 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
- 5.83
- org.kde.kirigami 2.15
Definition at line 63 of file BasicListItem.qml.
◆ leadingPadding
|
read |
This property holds the padding after the leading item.
- Since
- org.kde.kirigami 2.15
Definition at line 47 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 135 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 144 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
- 5.77
- org.kde.kirigami 2.15
Definition at line 154 of file BasicListItem.qml.
◆ subtitle
|
read |
This property holds an optional subtitle that can appear under the label.
- Since
- 5.70
- org.kde.kirigami 2.12
Definition at line 36 of file BasicListItem.qml.
◆ subtitleItem
|
read |
This property holds the subtitle item, for accessing the usual Text properties.
- Since
- 5.84
- org.kde.kirigami 2.16
Definition at line 187 of file BasicListItem.qml.
◆ textSpacing
|
read |
This property holds the spacing between the label row and subtitle row.
- Since
- 5.83
- org.kde.kirigami 2.15
Definition at line 161 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 69 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
- 5.83
- org.kde.kirigami 2.15
Definition at line 90 of file BasicListItem.qml.
◆ trailingPadding
|
read |
This property holds the padding before the trailing item.
- Since
- org.kde.kirigami 2.15
Definition at line 74 of file BasicListItem.qml.
The documentation for this class was generated from the following file:
Documentation copyright © 1996-2023 The KDE developers.
Generated on Thu Jun 8 2023 03:59:35 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006
KDE's Doxygen guidelines are available online.