aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/controls/ToolsColumn.qml
blob: 3091276ecbb7f04590d1f76b9bf2627b0716e728 (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
84
85
86
87
88
89
90
91
92
93
94
95
96
97
98
99
100
101
102
103
104
105
106
107
108
109
110
111
112
113
114
115
116
117
118
119
120
121
122
123
124
125
126
127
128
129
130
131
132
133
134
135
136
137
138
139
140
141
142
143
144
145
146
147
148
149
150
151
152
153
154
/****************************************************************************
**
** Copyright (C) 2019 Luxoft Sweden AB
** Copyright (C) 2018 Pelagicore AG
** Contact: https://www.qt.io/licensing/
**
** This file is part of the Neptune 3 IVI UI.
**
** $QT_BEGIN_LICENSE:GPL-QTAS$
** Commercial License Usage
** Licensees holding valid commercial Qt Automotive Suite 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 General Public License Usage
** Alternatively, this file may be used under the terms of the GNU
** General Public License version 3 or (at your option) any later version
** approved by the KDE Free Qt Foundation. The licenses are as published by
** the Free Software Foundation and appearing in the file LICENSE.GPL3
** included in the packaging of this file. Please review the following
** information to ensure the GNU General Public License requirements will
** be met: https://www.gnu.org/licenses/gpl-3.0.html.
**
** $QT_END_LICENSE$
**
** SPDX-License-Identifier: GPL-3.0
**
****************************************************************************/

import QtQuick 2.10
import QtQuick.Controls 2.3
import QtQuick.Layouts 1.2

import shared.Sizes 1.0
import shared.utils 1.0

/*!
    \qmltype ToolsColumn
    \inqmlmodule controls
    \inherits ColumnLayout
    \since 5.11
    \brief The tools column component for Neptune 3 applications.

    The ToolsColumn provides a custom column of tool buttons for Neptune 3 Applications
    to follow the specification where only one of them can be selected at any given time.

    See \l{Neptune 3 UI Components and Interfaces} to see more available components in
    Neptune 3 UI.

    \section2 Example Usage

    The following example uses \l{ToolsColumn}:

    \qml
    import QtQuick 2.10
    import shared.controls 1.0

    Item {
        id: root

        ToolsColumn {
            translationContext: "MyToolsColumn"
            model: ListModel {
                ListElement { icon: "ic-foo"; text: QT_TRANSLATE_NOOP("MyToolsColumn", "foo") }
                ListElement { icon: "ic-bar"; text: QT_TRANSLATE_NOOP("MyToolsColumn", "bar") }
            }
        }
    }
    \endqml
*/

ColumnLayout {
    id: root

    width: Sizes.dp(135)
    spacing: Sizes.dp(24)

    /*!
        \qmlproperty int ToolsColumn::currentIndex

        This property holds the current selected index of the tools column.

        This property's default is 0.
    */
    property int currentIndex: 0

    /*!
        \qmlproperty string ToolsColumn::currentText
        \readonly

        This property holds the current selected text of the tools column.
    */
    readonly property string currentText: model ? model.get(currentIndex).text : ""

    /*!
        \qmlproperty string ToolsColumn::currentItem

        This property holds the current selected item of the tools column.
    */
    property Item currentItem: repeater.itemAt(currentIndex)

    /*!
        \qmlproperty var ToolsColumn::model

        This property holds the model to be delegated in the tools column.
    */
    property alias model: repeater.model

    /*!
        \qmlproperty string ToolsColumn::translationContext
        \readonly

        This property holds the translation context of the tools column.

        This property's default is 0.
    */
    property string translationContext

    /*!
        \qmlsignal ToolsColumn::clicked

        This signal is emitted when one of the tool is clicked by the user.
    */
    signal clicked()

    ButtonGroup { id: buttonGroup }

    Repeater {
        id: repeater

        ToolButton {
            Layout.preferredWidth: Sizes.dp(135)
            Layout.preferredHeight: Sizes.dp(96)
            Layout.alignment: Qt.AlignHCenter
            objectName: model.objectName ? model.objectName : ""
            baselineOffset: 0
            checkable: true
            checked: root.currentIndex === index
            icon.name: model.icon ? (checked ? model.icon + "_ON" : model.icon + "_OFF") : ""
            text: qsTranslate(root.translationContext, model.text)
            font.pixelSize: Sizes.fontSizeS
            enabled: !model.greyedOut
            display: AbstractButton.TextUnderIcon
            onClicked: {
                root.currentIndex = index;
                root.clicked();
            }
            ButtonGroup.group: buttonGroup
        }
    }
}