SectionItem

Search for usage in LXR

SectionItem Class Reference
Inheritance diagram for SectionItem:

Properties

bool childCheckable
 
alias content
 
bool flat
 
alias iconSizeHint
 
alias iconSource
 
alias imageSource
 
alias label1
 
alias label2
 
alias label3
 
alias label4
 
alias template
 

Detailed Description

An item used for holding information in a vertical column layout.

Since
org.mauikit.controls

This control inherits from QQC2 ItemDelegate, to checkout its inherited properties refer to the Qt Docs.

Although it is similar to the SectionGroup (an information header with the children in a vertical layout) this control has some functionality differences, like being interactive and a different styling of the information labels. It is commonly use as the children elements of the SectionGroup.

Note
There is also the FlexSectionItem, which uses a dynamic layout for wrapping the content that does not fit.
See also
FlexSectionItem
Three types of sections inside a SectionGroup

If the first and single child element of this control is checkable, then the state of such control will be toggled by clicking on the area of the SectionItem.

Maui.SectionGroup
{
title: "Section with Children"
description: "The description label can be a bit longer explaining something important. Maybe?"
Maui.SectionItem
{
label1.text: "Checkable section item"
iconSource: "folder"
Switch
{
onToggled: checked = !checked
}
}
Maui.SectionItem
{
label1.text: "Single section item"
iconSource: "anchor"
}
Maui.SectionItem
{
label1.text: "Hello this is a two line section item"
label2.text : "Subtitle text"
TextArea
{
Layout.fillWidth: true
}
}
}

You can find a more complete example at this link.

Definition at line 77 of file SectionItem.qml.

Property Documentation

◆ childCheckable

bool SectionItem::childCheckable
read

Whether the first children element from the content is checkable.

If it is the the control will have a hover effect to hint about the item being checkable.

Remarks
This property is read-only

Definition at line 135 of file SectionItem.qml.

◆ content

alias SectionItem::content
read
Remarks
This is the default property

Definition at line 89 of file SectionItem.qml.

◆ flat

bool SectionItem::flat
read

Whether the control should be styled as flat, as in not having a background or hover/pressed visual effect hints.

By default this is set to !Handy.isMobile

See also
Handy::isMobile

Definition at line 129 of file SectionItem.qml.

◆ iconSizeHint

alias SectionItem::iconSizeHint
read
See also
ListItemTemplate::iconSizeHint

Definition at line 123 of file SectionItem.qml.

◆ iconSource

alias SectionItem::iconSource
read
See also
ListItemTemplate::iconSource

Definition at line 115 of file SectionItem.qml.

◆ imageSource

alias SectionItem::imageSource
read
See also
ListItemTemplate::imageSource

Definition at line 119 of file SectionItem.qml.

◆ label1

alias SectionItem::label1
read
See also
ListItemTemplate::label1

Definition at line 99 of file SectionItem.qml.

◆ label2

alias SectionItem::label2
read
See also
ListItemTemplate::label2

Definition at line 103 of file SectionItem.qml.

◆ label3

alias SectionItem::label3
read
See also
ListItemTemplate::label3

Definition at line 107 of file SectionItem.qml.

◆ label4

alias SectionItem::label4
read
See also
ListItemTemplate::label4

Definition at line 111 of file SectionItem.qml.

◆ template

alias SectionItem::template
read

Definition at line 95 of file SectionItem.qml.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2024 The KDE developers.
Generated on Fri May 17 2024 11:56:16 by doxygen 1.10.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.