FormEntry QML Type

The base type of all Form entries. More...

• List of all members, including inherited members

Properties

• clickEnabled : bool
• contentItem : Item
• leadingItems : list<Item>
• subtitle : string
• title : string
• trailingItems : list<Item>

Signals

• clicked()

Detailed Description

This element should always be positioned in a FormGroup. It is The base for all the items livinging in a Form and will take care of common styling and behaviors, like positioning of titles and subtitles, background and what happens when the item is clicked even outside the contentItem.

Example usage:

 import QtQuick.Controls as QQC
 import org.kde.kirigami as Kirigami

 Kirigami.Form {
   Kirigami.FormGroup {
       title: "Global Settings"
       Kirigami.FormEntry {
           contentItem: QQC.CheckBox {
               text: "Show Sidebar"
           }
       }
       Kirigami.FormEntry {
           contentItem: QQC.CheckBox {
               text: "Auto Save"
           }
       }
   }
   Kirigami.FormGroup {
       title: "Theme Options"
       Kirigami.FormEntry {
           title: "Colors"
           contentItem: QQC.CheckBox {
               text: "Dark Theme"
           }
       }
       Kirigami.FormSeparator {}
       Kirigami.FormEntry {
           contentItem: QQC.CheckBox {
               text: "High Contrast"
           }
       }
       ...
   }
 }

The form entry will contain a main central contentItem, with optional title, subtitle, and leading and trailing items, with the following layout:

See also Form and FormGroup.

Property Documentation

clickEnabled : bool

Make the whole entry behave like a button

When true, clicking anywhere on this will emit the clicked signal. Depending on contentITem, if it's a clickable item itself, the click will be passed to it: for instance if contentItem is a CheckBox, clicking anywhere, even outside the checkbox will toggle the CheckBox checked status.

contentItem : Item

The main contents of this entry.

The contentItem is what contains the main contents of the entry, which are usually a simple Control such as a CheckBox, a TextField and so on. If is needed to have more than one control, set a layout as contentItem, such as a RowLayout, GridLAyout and so on.

leadingItems : list<Item>

Items to be positioned before the contentItem

a list of items to be laid out before the contentItem (at the left on LTR locales) for instance a big icon, that will cover the cumulative height of the title, contentItem and subtitle.

subtitle : string

Extra subtitle.

If set a subtitle (potentially on multiple lines) will be displayed under the contentItem. Use this for form entries with a more technical meaning that need more explanation or entries that contain a potentially dangerous action.

title : string

Entry title.

If set, a title will be displayed nearby the contentItem, either on top or on the left, Depending from the style or form factor. Use this when the contentItem appearance doesn't provide enough explanation on what it does.

trailingItems : list<Item>

Items to be positioned after the contentItem

a list of items to be laid out after the contentItem (at the right on LTR locales) for instance a ContextualHelpButton, that will cover the cumulative height of the title, contentItem and subtitle.

Signal Documentation

clicked()

Emitted when the user clicks or taps over this Entry.