ListItemTemplate Class Reference

Inheritance diagram for ListItemTemplate:

Properties
alias	content
int	fillMode
int	headerSizeHint
bool	highlighted
bool	hovered
Component	iconComponent
alias	iconContainer
alias	iconItem
int	iconSizeHint
string	iconSource
alias	iconVisible
int	imageSizeHint
string	imageSource
bool	isCurrentItem
bool	isMask
alias	label1
alias	label2
alias	label3
alias	label4
bool	labelsVisible
alias	layout
alias	leftLabels
int	maskRadius
alias	rightLabels
alias	spacing
alias	text1
alias	text2
alias	text3
alias	text4

Additional Inherited Members
Public Member Functions inherited from QtQuick.Item
	childAt (real x, real y)
bool	contains (point point)
	dumpItemTree ()
	forceActiveFocus ()
	forceActiveFocus (Qt::FocusReason reason)
bool	grabToImage (callback, targetSize)
point	mapFromGlobal (real x, real y)
point	mapFromItem (Item item, point p)
point	mapFromItem (Item item, real x, real y)
rect	mapFromItem (Item item, real x, real y, real width, real height)
rect	mapFromItem (Item item, rect r)
point	mapToGlobal (real x, real y)
point	mapToItem (Item item, point p)
point	mapToItem (Item item, real x, real y)
rect	mapToItem (Item item, real x, real y, real width, real height)
rect	mapToItem (Item item, rect r)
	nextItemInFocusChain (bool forward)

Detailed Description

A template for an horizontal layout of information.

This controls inherits from QQC2 Item, to checkout its inherited properties refer to the Qt Docs.

The structure of this control is divided into a left side header for the image/icon and a four [4] labels for the title, message at the right side of the header, and at the far right side another two labels for complementary information.

The icon header section can be modified and assigned to any custom control.

See also

iconComponent

For extra information checkout the ListBrowserDelegate documentation, since this template element is used as its base.

Definition at line 36 of file ListItemTemplate.qml.

Property Documentation

content

list< QtObject > ListItemTemplate::content

read

By default all children will be positioned at the right end of the row.

Remarks

This is the default property

The positioning of the elements is handled by a RowLayout, so use the attached properties.

Definition at line 45 of file ListItemTemplate.qml.

fillMode

int ListItemTemplate::fillMode

read

See also

IconItem::fillMode By default this is set to Image.PreserveAspectFit.

Note

For more options and information review the QQC2 Image documentation.

Definition at line 182 of file ListItemTemplate.qml.

headerSizeHint

int ListItemTemplate::headerSizeHint

read

The size of the header section.

This is the size the header container will take. By default this is set to -1 which means that the size of the header will be determined by the child implicit height and width.

Definition at line 158 of file ListItemTemplate.qml.

highlighted

bool ListItemTemplate::highlighted

read

Whether the control should be styled as being highlighted by some external event.

By default this is set to false.

Definition at line 206 of file ListItemTemplate.qml.

hovered

bool ListItemTemplate::hovered

read

Whether the control should be styled as being hovered by a cursor.

By default his is set to false.

Definition at line 201 of file ListItemTemplate.qml.

iconComponent

Component ListItemTemplate::iconComponent

read

The header section can be modified by changing its component to a custom one.

By default the component used for the iconComponent is a MauiKit IconItem element.

Note

When using a custom component for the header section, pay attention that it has an implicitHeight and implicitWidth set.

Definition at line 191 of file ListItemTemplate.qml.

iconContainer

Loader ListItemTemplate::iconContainer

read

The container for the icon header section.

Remarks

This property is read-only

This is handled by a QQC2 Loader. By default the source component will be loaded asynchronous.

Definition at line 105 of file ListItemTemplate.qml.

iconItem

Item ListItemTemplate::iconItem

read

The Item loaded as the icon header section.

Remarks

This property is read-only

The component used as the icon header is loaded with a QQC2 Loader - this property exposes that element that was loaded. By default the loaded item will be a MauiKit IconItem, but if another component is used for iconComponent, that will be the resulting Item.

See also

structure

Definition at line 114 of file ListItemTemplate.qml.

iconSizeHint

int ListItemTemplate::iconSizeHint

read

A size hint for the icon to be used in the header.

The final size will depend on the available space.

Definition at line 148 of file ListItemTemplate.qml.

iconSource

string ListItemTemplate::iconSource

read

See also

IconItem::iconSource

Definition at line 166 of file ListItemTemplate.qml.

iconVisible

bool ListItemTemplate::iconVisible

read

Whether the icon/image header section should be visible.

Definition at line 119 of file ListItemTemplate.qml.

imageSizeHint

int ListItemTemplate::imageSizeHint

read

A size hint for the image to be used in the header.

The final size will depend on the available space. By default this is set to -1 which means that the image header will take the rest of the available space.

Definition at line 153 of file ListItemTemplate.qml.

imageSource

string ListItemTemplate::imageSource

read

See also

IconItem::imageSource

Definition at line 162 of file ListItemTemplate.qml.

isCurrentItem

bool ListItemTemplate::isCurrentItem

read

Whether this element is currently on a selected or checked state.

This is used to highlight the component accordingly. By default this is set to false.

Definition at line 171 of file ListItemTemplate.qml.

isMask

bool ListItemTemplate::isMask

read

See also

IconItem::isMask By default this is set to evaluate true for icons equal or smaller in size then 16 pixels.

Definition at line 196 of file ListItemTemplate.qml.

label1

Label ListItemTemplate::label1

read

An alias for the QQC2 Label handling the title text.

Remarks

This property is read-only

Exposed for fine tuning the label font properties.

Note

See the QQC2 Label documentation for more information.

Definition at line 77 of file ListItemTemplate.qml.

label2

Label ListItemTemplate::label2

read

An alias for the QQC2 Label handling the subtitle text.

Remarks

This property is read-only

Exposed for fine tuning the label font properties.

Note

See the QQC2 Label documentation for more information.

Definition at line 84 of file ListItemTemplate.qml.

label3

Label ListItemTemplate::label3

read

An alias for the QQC2 Label handling the extra information text.

Remarks

This property is read-only

Exposed for fine tuning the label font properties.

Note

See the QQC2 Label documentation for more information.

Definition at line 91 of file ListItemTemplate.qml.

label4

Label ListItemTemplate::label4

read

An alias for the QQC2 Label handling the extra information text.

Remarks

This property is read-only

Exposed for fine tuning the label font properties.

Note

See the QQC2 Label documentation for more information.

Definition at line 98 of file ListItemTemplate.qml.

labelsVisible

bool ListItemTemplate::labelsVisible

read

Whether the two bottom labels, for title and message, should be displayed.

By default this is set to true.

Definition at line 176 of file ListItemTemplate.qml.

layout

RowLayout ListItemTemplate::layout

read

An alias to the container layout for this control.

Remarks

This property is read-only

This is handled by a RowLayout.

Definition at line 144 of file ListItemTemplate.qml.

leftLabels

ColumnLayout ListItemTemplate::leftLabels

read

An alias to the column element hosting the title and message labels.

Remarks

This property is read-only

See also

label1

label2

Definition at line 128 of file ListItemTemplate.qml.

maskRadius

int ListItemTemplate::maskRadius

read

See also

IconItem::maskRadius

Definition at line 186 of file ListItemTemplate.qml.

rightLabels

ColumnLayout ListItemTemplate::rightLabels

read

An alias to the column element hosting the far-right extra labels.

Remarks

This property is read-only

See also

label3

label4

Definition at line 137 of file ListItemTemplate.qml.

spacing

int ListItemTemplate::spacing

read

The spacing size between the image/icon header and the labels columns.

Definition at line 50 of file ListItemTemplate.qml.

text1

string ListItemTemplate::text1

read

The text use for the main title text.

Definition at line 55 of file ListItemTemplate.qml.

text2

string ListItemTemplate::text2

read

The text use for the subtitle text.

Definition at line 60 of file ListItemTemplate.qml.

text3

string ListItemTemplate::text3

read

The text use for the left-top far side text.

Definition at line 65 of file ListItemTemplate.qml.

text4

string ListItemTemplate::text4

read

The text use for the left-bottom far side text.

Definition at line 70 of file ListItemTemplate.qml.

---

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

• ListItemTemplate.qml