aboutsummaryrefslogtreecommitdiffstats
path: root/imports_shared/shared/utils/Tracer.qml
blob: 7660e03d666dfa4d83a4013fb0cb8da61360b435 (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
155
156
157
158
159
160
161
162
163
/****************************************************************************
**
** Copyright (C) 2017 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.0
import shared.utils 1.0

/*!
    \qmltype Tracer
    \inqmlmodule utils
    \inherits MouseArea
    \since 5.11
    \brief The tracer of a Neptune 3 application.

    The Tracer is used to mark desired area to help developer see if the created
    component is created as intended or not.

    \section2 Example Usage

    The following example shows how to use \l{Tracer}:

    \qml
    import QtQuick 2.10
    import shared.utils 1.0

    Rectangle {
        id: root

        width: 80
        height: 80

        Tracer {
            visible: true
        }
    }
    \endqml
*/

MouseArea {
    id: root

    /*!
        \qmlproperty color Tracer::color
        \readonly

        This property holds a random color to mark the desired area.
    */
    readonly property color color: randomColor();

    /*!
        \qmlproperty string Tracer::text
        \readonly

        This property holds the object name of its parent.
    */
    readonly property string text: parent.objectName

    /*!
        \qmlproperty real Tracer::padding
        \readonly

        This property specifies the default padding number of Tracer.
    */
    readonly property real padding: 0.5

    /*!
        \qmlproperty bool Tracer::opaque

        This property specifies whether Tracer is suppose to be transparent or not.
    */
    property bool opaque: false

    /*!
        \qmlproperty bool Tracer::fill
        \readonly

        This property describes whether Tracer is filled or not.
    */
    readonly property bool fill: root.opaque

    /*!
        \qmlmethod color Tracer::randomColor()

        Generate random color for the Tracer's border.
    */
    function randomColor() {
        return Qt.rgba(Math.random(), Math.random(), Math.random(), 1.0)
    }

    visible: false
    acceptedButtons: Qt.RightButton
    anchors.fill: parent
    propagateComposedEvents: true

    onPressAndHold: {
        console.log(Logging.sysui, 'trace: ' + root.parent)

        console.log(Logging.sysui, 'Hierarchy: ')
        var parent = root.parent;
        var indent = '  ';
        while (parent) {
            console.log(Logging.sysui, indent + '+ ' + parent)
            indent += '  ';
            parent = parent.parent;
        }
    }

    Rectangle {
        id: fill
        anchors.fill: parent
        anchors.margins: root.padding
        color: root.fill?root.color:'transparent'
        opacity: root.opaque? 1.0 : 0.10
    }

    Rectangle {
        id: frame
        anchors.fill: parent
        anchors.margins: root.padding
        color: 'transparent'
        border.color: root.color
        border.width: 1
        opacity: 0.80
    }

    Text {
        id: note
        anchors.bottom: parent.bottom
        anchors.right: parent.right
        anchors.margins: 4
        horizontalAlignment: Text.AlignRight
        text: root.text
        font.pixelSize: 10
        color: root.color
    }
}