org::kde::kirigami::FormLayout

Search for usage in LXR

org::kde::kirigami::FormLayout Class Reference
Inheritance diagram for org::kde::kirigami::FormLayout:

Properties

list< ItemtwinFormLayouts
 
bool wideMode
 

Additional Inherited Members

- Public Member Functions inherited from QtQuick.Item
 childAt (x, real y)
 
bool contains (point)
 
 forceActiveFocus ()
 
 forceActiveFocus (reason)
 
bool grabToImage (callback, targetSize)
 
object mapFromGlobal (x, real y)
 
object mapFromItem (item, point p)
 
object mapFromItem (item, real x, real y)
 
object mapFromItem (item, real x, real y, real width, real height)
 
object mapFromItem (item, rect r)
 
object mapToGlobal (x, real y)
 
object mapToItem (item, point p)
 
object mapToItem (item, real x, real y)
 
object mapToItem (item, real x, real y, real width, real height)
 
object mapToItem (item, rect r)
 
 nextItemInFocusChain (forward)
 

Detailed Description

This is the base class for Form layouts conforming to the Kirigami Human Interface Guidelines.

The layout consists of two columns: the left column contains only right-aligned labels provided by a Kirigami.FormData attached property, the right column contains left-aligned child types.

Child types can be sectioned using an QtQuick.Item or Kirigami.Separator with a Kirigami.FormData attached property, see FormLayoutAttached::isSection for details.

Example usage:

import org.kde.kirigami 2.3 as Kirigami
Kirigami.FormLayout {
TextField {
Kirigami.FormData.label: "Label:"
}
Kirigami.Separator {
Kirigami.FormData.label: "Section Title"
Kirigami.FormData.isSection: true
}
TextField {
Kirigami.FormData.label: "Label:"
}
TextField {
}
}
See also
FormLayoutAttached
Since
2.3

Definition at line 45 of file FormLayout.qml.

Property Documentation

◆ twinFormLayouts

list<Item> org::kde::kirigami::FormLayout::twinFormLayouts
read

If for some implementation reason multiple FormLayouts have to appear on the same page, they can have each other in twinFormLayouts, so they will vertically align with each other perfectly.

Since
5.53

Definition at line 69 of file FormLayout.qml.

◆ wideMode

bool org::kde::kirigami::FormLayout::wideMode
read

This property tells whether the form layout is in wide mode.

If true, the layout will be optimized for a wide screen, such as a desktop machine (the labels will be on a left column, the fields on a right column beside it), if false (such as on a phone) everything is laid out in a single column.

By default this property automatically adjusts the layout if there is enough screen space.

Set this to true for a convergent design, set this to false for a mobile-only design.

Definition at line 61 of file FormLayout.qml.


The documentation for this class was generated from the following file:
This file is part of the KDE documentation.
Documentation copyright © 1996-2023 The KDE developers.
Generated on Mon Feb 6 2023 04:13:18 by doxygen 1.8.17 written by Dimitri van Heesch, © 1997-2006

KDE's Doxygen guidelines are available online.