aboutsummaryrefslogtreecommitdiffstats
path: root/plugins/controls/ListItem.qml
blob: 671982350055cf5b668157ea361971b45fb2c477 (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
/****************************************************************************
**
** 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.3

import shared.utils 1.0
import shared.Style 1.0
import shared.Sizes 1.0

/*!
    \qmltype ListItem
    \inqmlmodule controls
    \inherits ListItemBasic
    \since 5.11
    \brief The list item component of Neptune 3.

    The ListItem provides a type of a list item with one button or text at the right side

    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{ListItem}:

    \qml
    import QtQuick 2.10
    import shared.controls 1.0

    Item {
        id: root
        ListView {
            model: 3
            delegate:  ListItem {
                icon.name: "ic-update"
                rightToolSymbol: "ic-close"
                text: "Title ListItem"
                secondaryText: "Secondary Text List Item"
            }
        }
    }
    \endqml

*/

ListItemBasic {
    id: root

    /*!
        \qmlproperty string ListItem::secondaryText

        This property holds a textual component that is aligned to the right side of ListItem.
    */
    property string secondaryText: ""

    /*!
        \qmlproperty string ListItem::rightToolSymbol

        This property holds the tool icon source that is aligned to the right side of ListItem.
    */
    property string rightToolSymbol: ""

    /*!
        \qmlsignal ListItem::rightToolClicked()

        This signal is emitted when right tool is clicked.
    */
    signal rightToolClicked()

    accessoryDelegateComponent1: Label {
        font.pixelSize: Sizes.fontSizeS
        elide: Text.ElideRight
        horizontalAlignment: Text.AlignRight
        verticalAlignment: Text.AlignVCenter
        visible: root.secondaryText
        color: Style.contrastColor
        text: root.secondaryText
    }

    rightSpacerUsed: (root.secondaryText !== "")&&(root.rightToolSymbol === "")
    middleSpacerUsed: root.secondaryText !== ""
    dividerVisible: true

    accessoryDelegateComponent2: ToolButton {
        implicitWidth: rightToolSymbol ? Sizes.dp(100) : 0
        implicitHeight: rightToolSymbol ? root.height : 0
        baselineOffset: 0
        icon.name: root.rightToolSymbol
        visible: root.rightToolSymbol !== ""
        onClicked: root.rightToolClicked()
    }
}