This property holds the view index that has been selected as current. Selecting an index to be current is done by either using the arrow keys, clicking on a row (or a cell) with the mouse, or assign currentIndex a value explicitly.

Note: currentIndex is an index into the the view model. In this model, all tree nodes that are visible in the view are flattened into a list that can be shown in a table column. This also means that currentIndex.row is the table row relative to root node. To get the current index in the model, where the row is relative to parent node, use currentModelIndex or mapToModel():

var indexInModel = currentModelIndex
var indexInModelMapped = mapToModel(currentIndex)
console.assert(indexInModel == indexInModelMapped)

If no index has been selected as current, or if currentModelIndex is is not visible in the view, currentIndex.valid will be false.

See also currentModelIndex, currentItem, and mapToModel().

This property holds the item that is selected as current. Selecting an item to be current is done by either using the arrow keys, clicking on a row (or a cell) with the mouse, or assign a value to currentIndex explicitly.

Note: Using currentItem is almost the same as calling itemAtModelIndex(currentModelIndex). The difference is that the latter expression will only change when currentModelIndex changes. But currentItem can also change as a result of the view doing a relayout behind the scenes (which can force delegate items to be reloaded or recycled). Since the item can be recycled or destroyed at any point in time behind the applications back, you should never store this value.

if currentIndex.valid is false, this property will be null.

See also itemAtCell(), currentIndex, currentModelIndex, and itemAtModelIndex().

This property holds the model index that has been selected as current. Selecting an index to be current is done by either using the arrow keys, clicking on a row (or a cell) with the mouse, or assign currentIndex a value explicitly.

Note: currentModelIndex is an index into the the model. This also means that currentModelIndex.row is the child number relative to the parent node. To get the current row in the view, which is relative to the root, use currentIndex or mapFromModel():

var indexInView = currentViewIndex
var indexInViewMapped = mapFromModel(currentModelIndex)
console.assert(indexInView == indexInViewMapped)

If no index has been selected as current, currentModelIndex.valid will be false.

See also currentIndex, currentItem, and mapFromModel().

This property holds how you would like the user to be able navigate the tree. It can have the following values:

Note: the selected mode can also affect how the tree is styled by the delegate.

This property holds a set of hints that can be used to tweak the appearance of the delegate without the need to create a custom one. The hints that can be set is the following:

Note: a delegate is free to ignore any hints specified by the application.

This attached property holds the tree depth (the number of parents up to the root) of the delegate instance. It is attached to each instance of the delegate.

This attached property holds if the delegate instance is to be shown as having children (the model index represented by the instance has children in the model). It is attached to each instance of the delegate.

This attached property holds if the delegate instance is to be shown as expanded (the view index represented by the instance is expanded in the view model). It is attached to each instance of the delegate.

This attached property holds the view that manages the delegate instance. It is attached to each instance of the delegate.

Collapses the tree node at the given row in the view.

Note: this function will not affect the model, only the visual representation in the view.

See also viewIndex, expand(), expandModelIndex(), collapseModelIndex(), and isExpanded().

Collapses the tree node at the given modelIndex. This is a convenience for doing:

collapse(mapFromModel(modelIndex).row)

See also viewIndex, collapse(), expand(), expandModelIndex(), and isExpanded().

Returns the column under x in view coordinates.

If includeSpacing is set to false, and x is on top of the spacing between the columns, the return value will be -1. Otherwise, if x is on top of the spacing and includeSpacing is set to true, returns the column closest to the position.

Returns the depth (the number of parents up to the root) of the given row.

Note: row should be the row in the view, not in the model.

See also viewIndex.

Expands the tree node at the given row in the view.

Note: this function will not affect the model, only the visual representation in the view.

See also viewIndex, collapse(), expandModelIndex(), collapseModelIndex(), and isExpanded().

Expands the tree node at the given modelIndex. This is a convenience for doing:

expand(mapFromModel(modelIndex).row)

See also viewIndex, collapse(), expand(), collapseModelIndex(), and isExpanded().

Returns if the given row in the view is shown as expanded.

Note: row should be the row in the view, not in the model.

See also viewIndex.

Returns if the given row in the view has siblings.

Note: row should be the row in the view, not in the model.

See also viewIndex.

Returns if the given row in the view is shown as expanded.

Note: row should be the row in the view, not in the model.

See also viewIndex.

Returns true if the given modelIndex is shown as expanded in the view. This is a convenience for doing:

isExpanded(mapFromModel(modelIndex).row)

See also viewIndex.

Returns the item inside the given table cell. If the cell is not visible in the view, returns null.

See also currentItem and itemAtIndex().

Returns the item at the given view index viewIndex. If viewIndex.valid is false, returns null.

See also currentItem, itemAtCell(), viewIndex(), and itemAtModelIndex().

Returns the item at the given model index modelIndex. If the item that represents the model index is not visible in the view, returns null. Convenience for doing:

itemAtIndex(mapFromModel(modelIndex))

See also currentItem, itemAtCell(), viewIndex(), and itemAtIndex().

Maps an index, modelIndex, pointing to an item in the model to the corresponding model index in the view (the view model).

TreeView uses a view model internally to convert a tree model into a model suited to be shown in a TableView. This view model will flatten the parts of the tree model that at any point in time is visible inside view, to a list. Depending on what you need to do, it's sometimes easier to work with model indexes rather than view indexes, and vice-versa.

See also mapToModel().

Maps viewIndex, an index pointing to an item in the view (the view model), to the corresponding model index in the model.

TreeView uses a view model internally to convert a tree model into a model suited to be shown in a TableView. This view model will flatten the parts of the tree model that at any point in time is visible inside view, to a list. Depending on what you need to do, it's sometimes easier to work with model indexes rather than view indexes, and vice-versa.

See also mapFromModel().

Returns the row under y in view coordinates.

If includeSpacing is set to false, and y is on top of the spacing between the rows, returns -1. Otherwise, if y is on top of the spacing and includeSpacing is set to true, returns the row closest to the position.

Toggles if the tree node at the given row should be expanded. This is a convenience for doing:

if (isExpanded(row))
    collapse(row)
else
    expand(row)

Toggles if the tree node at the given modelIndex should be expanded. This is a convenience for doing:

if (isModelIndexExpanded(modelIndex))
    collapseModelIndex(modelIndex)
else
    expandModelIndex(modelIndex)

Creates a model index into the view model from the given row and column.

Note: this index is only valid for use with the view. To create a model index to use with the model, refer to the documentation for QAbstractItemModel.