TreeView QML Type

This property is set to true if the view alternates the row color. The default value is true.

This property determines if the background should be filled or not.

The default value is true.

The current number of columns

This is the content footer of the view.

This is the content header of the view.

The model index of the current row in the tree view.

This property defines a delegate to draw a header.

In the header delegate you have access to the following special properties:

• styleData.value - the value or text for this item
• styleData.column - the index of the column
• styleData.pressed - true when the column is being pressed
• styleData.containsMouse - true when the column is under the mouse
• styleData.textAlignment - the horizontal text alignment of the column (since QtQuickControls 1.1)

This property determines if the header is visible. The default value is true.

This property defines a delegate to draw a specific cell.

In the item delegate you have access to the following special properties:

• styleData.selected - if the item is currently selected
• styleData.value - the value or text for this item
• styleData.textColor - the default text color for an item
• styleData.row - the index of the view row
• styleData.column - the index of the view column
• styleData.elideMode - the elide mode of the column
• styleData.textAlignment - the horizontal text alignment of the column
• styleData.pressed - true when the item is pressed
• styleData.hasActiveFocus - true when the row has focus
• styleData.index - the QModelIndex of the current item in the model
• styleData.depth - the depth of the current item in the model
• styleData.isExpanded - true when the item is expanded
• styleData.hasChildren - true if the model index of the current item has or can have children
• styleData.hasSibling - true if the model index of the current item has a sibling

Example:

 itemDelegate: Item {
     Text {
         anchors.verticalCenter: parent.verticalCenter
         color: styleData.textColor
         elide: styleData.elideMode
         text: styleData.value
     }
 }

This property holds the model providing data for the tree view.

The model provides the set of data that is displayed by the view. The TreeView accept models derived from the QAbstractItemModel class.

The model index of the root item in the tree view. The root item is the parent item to the view's top-level items. Only items descending from the root item will be visible in the view.

Its default value is an invalid QModelIndex, which means the whole model data is shown by the tree view (assigning undefined to this proprety resets it to its default value.)

This property was introduced in QtQuick.Controls 1.5.

This property defines a delegate to draw a row.

In the row delegate you have access to the following special properties:

• styleData.alternate - true when the row uses the alternate background color
• styleData.selected - true when the row is currently selected
• styleData.row - the index of the row
• styleData.hasActiveFocus - true when the row has focus (since QtQuick.Controls 1.3)
• styleData.pressed - true when the row is pressed (since QtQuick.Controls 1.3)

These properties determine the section labels.

See also ListView.section.

By default the selection model is null and only single selection is supported.

To use a different selection mode as described in selectionMode, an ItemSelectionModel must by set to the selection.

For example:

 TreeView {
    model: myModel
    selection: ItemSelectionModel {
         model: myModel
    }
    TableViewColumn {
        role: "name"
        title: "Name
    }
 }
 

See also selectionMode.

This enum indicates how the view responds to user selections:

The possible modes are:

• SelectionMode.NoSelection - Items cannot be selected.
• SelectionMode.SingleSelection - When the user selects an item, any already-selected item becomes unselected, and the user cannot unselect the selected item. (Default)
• SelectionMode.MultiSelection - When the user selects an item in the usual way, the selection status of that item is toggled and the other items are left alone.
• SelectionMode.ExtendedSelection - When the user selects an item in the usual way, the selection is cleared and the new item selected. However, if the user presses the Ctrl key when clicking on an item, the clicked item gets toggled and all other items are left untouched. If the user presses the Shift key while clicking on an item, all items between the current item and the clicked item are selected or unselected, depending on the state of the clicked item. Multiple items can be selected by dragging the mouse over them.
• SelectionMode.ContiguousSelection - When the user selects an item in the usual way, the selection is cleared and the new item selected. However, if the user presses the Shift key while clicking on an item, all items between the current item and the clicked item are selected.

This property was introduced in QtQuick.Controls 1.1.

Index of the current sort column. The default value is 0.

This sets the sorting order of the sort indicator The allowed values are:

• Qt.AscendingOrder - the default
• Qt.DescendingOrder

This property shows or hides the sort indicator The default value is false.

Emitted when the user activates a row in the tree by mouse or keyboard interaction. Mouse activation is triggered by single- or double-clicking, depending on the platform.

index is the model index of the activated row in the tree.

The corresponding handler is onActivated.

Note: The corresponding handler is onActivated.

Emitted when the user clicks a valid row in the tree by single clicking

index is the model index of the clicked row in the tree.

The corresponding handler is onClicked.

Note: The corresponding handler is onClicked.

Emitted when a valid row in the tree is collapsed, hiding its children.

index is the model index of the collapsed row in the tree.

The corresponding handler is onCollapsed.

Note: The corresponding handler is onCollapsed.

Emitted when the user double clicks a valid row.

index is the model index of the double clicked row in the tree.

The corresponding handler is onDoubleClicked.

Note: The corresponding handler is onDoubleClicked.

Emitted when a valid row in the tree is expanded, displaying its children.

index is the model index of the expanded row in the tree.

The corresponding handler is onExpanded.

Note: The corresponding handler is onExpanded.

Emitted when the user presses and holds a valid row in the tree.

index is the model index of the pressed row in the tree.

The corresponding handler is onPressAndHold.

Note: The corresponding handler is onPressAndHold.

Adds a column and returns the added column.

The column argument can be an instance of TableViewColumn, or a Component. The component has to contain a TableViewColumn. Otherwise null is returned.

Collapses the model item specified by the index.

See also collapsed and isExpanded.

Expands the model item specified by the index.

See also expanded and isExpanded.

Returns the column at the given index or null if the index is invalid.

Returns the model index of the visible row at the point x, y in content coordinates. If there is no visible row at the point specified, an invalid QModelIndex is returned.

Inserts a column at the given index and returns the inserted column.

The column argument can be an instance of TableViewColumn, or a Component. The component has to contain a TableViewColumn. Otherwise null is returned.

Returns true if the model item at index is expanded; otherwise returns false.

See also expanded and expand.

Moves a column from index to another.

Removes and destroys a column at the given index.

Resizes all columns to ensure that the column contents and the headers will fit.

This method was introduced in QtQuick.Controls 1.2.