Class TreeModel<T>

Namespace

Qt.Bridge.Models

Assembly

Qt.Bridge.CSharp.Api.dll

Provides a single-column tree model backed by TreeNode<T> nodes.

public class TreeModel<T> : NodeTreeModel<T> where T : TreeNode<T>

Type Parameters

T

The concrete node type.

Inheritance

object

Model

TreeModel

NodeTreeModel<T>

TreeModel<T>

Inherited Members

NodeTreeModel<T>.IsReadOnly

NodeTreeModel<T>.HasItemRole

NodeTreeModel<T>.SetNode(T, int, T)

NodeTreeModel<T>.ClearNodeData(T)

NodeTreeModel<T>.RowCount(ModelIndex)

NodeTreeModel<T>.ColumnCount(ModelIndex)

NodeTreeModel<T>.HasChildren(ModelIndex)

NodeTreeModel<T>.Index(int, int, ModelIndex)

NodeTreeModel<T>.Parent(ModelIndex)

NodeTreeModel<T>.Sibling(int, int, ModelIndex)

NodeTreeModel<T>.RoleNames()

NodeTreeModel<T>.Data(ModelIndex, int)

NodeTreeModel<T>.Flags(ModelIndex)

NodeTreeModel<T>.SetData(ModelIndex, object, int)

NodeTreeModel<T>.ClearItemData(ModelIndex)

NodeTreeModel<T>.DataChanged(T)

NodeTreeModel<T>.TryCreateIndex(T, out ModelIndex)

Model.CanFetchMore(ModelIndex)

Model.Buddy(ModelIndex)

Model.HeaderData(int, int, int)

Model.InsertRows(int, int, ModelIndex)

Model.InsertColumns(int, int, ModelIndex)

Model.MoveRows(ModelIndex, int, int, ModelIndex, int)

Model.MoveColumns(ModelIndex, int, int, ModelIndex, int)

Model.RemoveRows(int, int, ModelIndex)

Model.RemoveColumns(int, int, ModelIndex)

Model.Sort(int, int)

Model.FetchMore(ModelIndex)

Model.SetHeaderData(int, int, object, int)

Model.ModelChanged

Model.BeginInsertColumns(ModelIndex, int, int)

Model.EndInsertColumns()

Model.BeginMoveColumns(ModelIndex, int, int, ModelIndex, int)

Model.EndMoveColumns()

Model.BeginRemoveColumns(ModelIndex, int, int)

Model.EndRemoveColumns()

Model.BeginInsertRows(ModelIndex, int, int)

Model.EndInsertRows()

Model.BeginMoveRows(ModelIndex, int, int, ModelIndex, int)

Model.EndMoveRows()

Model.BeginRemoveRows(ModelIndex, int, int)

Model.EndRemoveRows()

Model.BeginResetModel()

Model.EndResetModel()

Model.DataChanged(ModelIndex, ModelIndex, int[])

Model.HeaderDataChanged(int, int, int)

object.Equals(object)

object.Equals(object, object)

object.GetHashCode()

object.GetType()

object.MemberwiseClone()

object.ReferenceEquals(object, object)

object.ToString()

Remarks

Create this model directly when application nodes can inherit TreeNode<T>. The parameterless constructor creates an empty root collection. Alternatively, pass an IList<T> to the constructor to use an existing root collection. Navigation and identity handling are supplied by the base class.

After the model is used by a view, change its structure only through AddRoot(T), InsertRoot(int, T), AddChild(T, T), InsertChild(T, int, T), and Remove(T). These methods notify connected views about the change.

Public properties declared by T become named values available to QML automatically. The inherited Parent and Children properties describe navigation state, so they are not exposed as QML values.

Single-column means that each node provides one displayed item or value; it does not limit the depth of the hierarchy. Use the non-generic TreeModel when each node needs sibling values, such as a file name, size, and modified date.

important

This convenience model exposes exactly one column for each node. Use the non-generic TreeModel when each node needs multiple columns.

public sealed class FolderNode(string name) : TreeNode<FolderNode>
{
    public string Name { get; } = name;
}

var folders = new TreeModel<FolderNode>();
var projects = folders.AddRoot(new FolderNode("Projects"));
folders.AddChild(projects, new FolderNode("Qt"));

Constructors

TreeModel()

Initializes a model with an empty root collection.

public TreeModel()

TreeModel(IList<T>)

Provides a single-column tree model backed by TreeNode<T> nodes.

public TreeModel(IList<T> rootNodes)

Parameters

rootNodes IList<T>

Remarks

Create this model directly when application nodes can inherit TreeNode<T>. The parameterless constructor creates an empty root collection. Alternatively, pass an IList<T> to the constructor to use an existing root collection. Navigation and identity handling are supplied by the base class.

After the model is used by a view, change its structure only through AddRoot(T), InsertRoot(int, T), AddChild(T, T), InsertChild(T, int, T), and Remove(T). These methods notify connected views about the change.

Public properties declared by T become named values available to QML automatically. The inherited Parent and Children properties describe navigation state, so they are not exposed as QML values.

Single-column means that each node provides one displayed item or value; it does not limit the depth of the hierarchy. Use the non-generic TreeModel when each node needs sibling values, such as a file name, size, and modified date.

important

This convenience model exposes exactly one column for each node. Use the non-generic TreeModel when each node needs multiple columns.

public sealed class FolderNode(string name) : TreeNode<FolderNode>
{
    public string Name { get; } = name;
}

var folders = new TreeModel<FolderNode>();
var projects = folders.AddRoot(new FolderNode("Projects"));
folders.AddChild(projects, new FolderNode("Qt"));

Properties

RoleProperties

Gets the public node properties exposed as automatic QML roles.

protected override IEnumerable<PropertyInfo> RoleProperties { get; }

Property Value

IEnumerable<PropertyInfo>

RootCount

Gets the number of root-level nodes.

protected override sealed int RootCount { get; }

Property Value

int

RootNodes

Gets a live, read-only view of the current root nodes.

public IReadOnlyList<T> RootNodes { get; }

Property Value

IReadOnlyList<T>

Methods

AddChild(T, T)

Appends a child node and notifies connected views.

public T AddChild(T parent, T child)

Parameters

parent T

child T

Returns

T

AddRoot(T)

Appends a root node and notifies connected views.

public T AddRoot(T node)

Parameters

node T

Returns

T

ChildAt(T, int)

Returns the child of parent at row.

protected override sealed T ChildAt(T parent, int row)

Parameters

parent T

row int

Returns

T

ChildCount(T)

Returns the number of children of parent.

protected override sealed int ChildCount(T parent)

Parameters

parent T

Returns

int

IndexOf(T)

Returns the current row of node under its parent.

protected override sealed int IndexOf(T node)

Parameters

node T

Returns

int

InsertChild(T, int, T)

Inserts a child node at the specified row and notifies connected views.

public T InsertChild(T parent, int row, T child)

Parameters

parent T

row int

child T

Returns

T

InsertRoot(int, T)

Inserts a root node at the specified row and notifies connected views.

public T InsertRoot(int row, T node)

Parameters

row int

node T

Returns

T

ParentOf(T)

Returns the parent of node, or null for a root node.

protected override sealed T ParentOf(T node)

Parameters

node T

Returns

T

Remove(T)

Removes a node and its descendants from the model.

public bool Remove(T node)

Parameters

node T

Returns

bool

RootAt(int)

Returns the root-level node at row.

protected override sealed T RootAt(int row)

Parameters

row int

Returns

T