summaryrefslogtreecommitdiff
path: root/src/controls/doc/src/qtquickcontrolsstyles-treeviewstyle.qdoc
blob: 4e135f260b4b38d899a4dd805fd3144d6c3e8a78 (plain)
1
2
3
4
5
6
7
8
9
10
11
12
13
14
15
16
17
18
19
20
21
22
23
24
25
26
27
28
29
30
31
32
33
34
35
36
37
38
39
40
41
42
43
44
45
46
47
48
49
50
51
52
53
54
55
56
57
58
59
60
61
62
63
64
65
66
67
68
69
70
71
72
73
74
75
76
77
78
79
80
81
82
83
/****************************************************************************
**
** Copyright (C) 2016 The Qt Company Ltd.
** Contact: https://www.qt.io/licensing/
**
** This file is part of the documentation of the Qt Toolkit.
**
** $QT_BEGIN_LICENSE:FDL$
** Commercial License Usage
** Licensees holding valid commercial Qt licenses may use this file in
** accordance with the commercial license agreement provided with the
** Software or, alternatively, in accordance with the terms contained in
** a written agreement between you and The Qt Company. For licensing terms
** and conditions see https://www.qt.io/terms-conditions. For further
** information use the contact form at https://www.qt.io/contact-us.
**
** GNU Free Documentation License Usage
** Alternatively, this file may be used under the terms of the GNU Free
** Documentation License version 1.3 as published by the Free Software
** Foundation and appearing in the file included in the packaging of
** this file. Please review the following information to ensure
** the GNU Free Documentation License version 1.3 requirements
** will be met: https://www.gnu.org/licenses/fdl-1.3.html.
** $QT_END_LICENSE$
**
****************************************************************************/

/*!
    \qmltype TreeViewStyle
    \inqmlmodule QtQuick.Controls.Styles
    \inherits BasicTableViewStyle
    \since 5.5
    \ingroup viewsstyling
    \ingroup controlsstyling
    \brief Provides custom styling for TreeView
*/

/*!
    \qmlproperty TreeView TreeViewStyle::control
    The \l TreeView this style is attached to.
*/

/*!
    \qmlproperty int TreeViewStyle::indentation
    The amount each level is indented relatively to its parent level.
*/

/*!
    \qmlproperty Component TreeViewStyle::branchDelegate

    This property defines a delegate to draw the branch indicator.

    In the branch delegate you have access to the following special properties:
    \list
    \li  styleData.row - the index of the view row
    \li  styleData.column - the index of the view column. Will always be 0
    \li  styleData.selected - if the item is currently selected
    \li  styleData.textColor - the default text color for an item
    \li  styleData.index - the QModelIndex of the current item in the model
    \li  styleData.depth - the depth of the current item in the tree model
    \li  styleData.isExpanded - true when the item is expanded
    \li  styleData.hasChildren - true if the model index of the current item has children
    \li  styleData.hasSibling - true if the model index of the current item has sibling
    \endlist
*/

/*!
    \qmlproperty Component TreeViewStyle::headerDelegate

    Delegate for header. This delegate is described in \l {TreeView}{TreeView.headerDelegate}.
*/

/*!
    \qmlproperty Component TreeViewStyle::rowDelegate

    Delegate for row. This delegate is described in \l {TreeView}{TreeView.rowDelegate}.
*/

/*!
    \qmlproperty Component TreeViewStyle::itemDelegate

    Delegate for item. This delegate is described in \l {TreeView}{TreeView.itemDelegate}.
*/