FormCard

Search for usage in LXR

FormCard Class Reference
Inheritance diagram for FormCard:

Properties

real bottomPadding
 
bool cardWidthRestricted
 
alias delegates
 
real horizontalPadding
 
real leftPadding
 
real maximumWidth
 
real padding
 
real rightPadding
 
real topPadding
 
real verticalPadding
 

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 single card that follows a form style.

This is the entrypoint component for FormCard.

A FormCard consists of a container that can be used to create your own Settings pages. It has a different color than the background.

Each FormCard can contain one or more Form delegates in its contentItem. To add more than one Form delegate to a FormCard, use a QtQuick.Layouts.ColumnLayout to group them.

Multiple FormCards can be grouped with a QtQuick.Layouts.ColumnLayout to represent different Settings sections.

Each section is expected to contain a FormCardHeader as the first delegate, which serves the role of a section title.

The height of the FormCard matches the implicit height of the contentItem and does not need to be set, while the width is expected to be given by the parent, for example, via a Layout.fillWidth.

Since
KirigamiAddons 0.11.0

Definition at line 35 of file FormCard.qml.

Property Documentation

◆ bottomPadding

real FormCard::bottomPadding
read

Definition at line 68 of file FormCard.qml.

◆ cardWidthRestricted

bool FormCard::cardWidthRestricted
read

Whether the card's width is being restricted.

Remarks
This property is read-only

Definition at line 77 of file FormCard.qml.

◆ delegates

alias FormCard::delegates
read

The delegates inside the Form card.

This is where you should add new Form delegates.

Remarks
This is the default property

Definition at line 43 of file FormCard.qml.

◆ horizontalPadding

real FormCard::horizontalPadding
read

Definition at line 64 of file FormCard.qml.

◆ leftPadding

real FormCard::leftPadding
read

Definition at line 70 of file FormCard.qml.

◆ maximumWidth

real FormCard::maximumWidth
read

The maximum width of the card.

This can be set to a specific value to force its delegates to wrap instead of using the entire width of the parent.

default: Kirigami.Units.gridUnit * 30

See also
cardWidthRestricted

Definition at line 54 of file FormCard.qml.

◆ padding

real FormCard::padding
read

The padding used around the content edges.

default: 0

Definition at line 60 of file FormCard.qml.

◆ rightPadding

real FormCard::rightPadding
read

Definition at line 72 of file FormCard.qml.

◆ topPadding

real FormCard::topPadding
read

Definition at line 66 of file FormCard.qml.

◆ verticalPadding

real FormCard::verticalPadding
read

Definition at line 62 of file FormCard.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 Jul 19 2024 11:50:50 by doxygen 1.11.0 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.