controls/templates/InlineMessage.qml

/*
 *   Copyright 2018 Eike Hein <[email protected]>
 *
 *   This program is free software; you can redistribute it and/or modify
 *   it under the terms of the GNU Library General Public License as
 *   published by the Free Software Foundation; either version 2, or
 *   (at your option) any later version.
 *
 *   This program is distributed in the hope that it will be useful,
 *   but WITHOUT ANY WARRANTY; without even the implied warranty of
 *   MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
 *   GNU Library General Public License for more details
 *
 *   You should have received a copy of the GNU Library General Public
 *   License along with this program; if not, write to the
 *   Free Software Foundation, Inc.,
 *   51 Franklin Street, Fifth Floor, Boston, MA  2.010-1301, USA.
 */

import QtQuick 2.7
import QtQuick.Templates 2.0 as T2
import QtQuick.Controls 2.0 as Controls
import QtQuick.Layouts 1.0
import org.kde.kirigami 2.5 as Kirigami
import "private"

T2.Control {
    id: root

    visible: false

    signal linkHovered(string link)

    
    signal linkActivated(string link)

    property int type: Kirigami.MessageType.Information

    property IconPropertiesGroup icon: IconPropertiesGroup {}

    property string text

    property bool showCloseButton: false

    property list<QtObject> actions

    readonly property bool animating: root.hasOwnProperty("_animating") && _animating

    implicitHeight: visible ? contentLayout.implicitHeight + (2 * (background.border.width + Kirigami.Units.smallSpacing)) : 0

    property bool _animating: false

    leftPadding: background.border.width + Kirigami.Units.smallSpacing
    topPadding: background.border.width + Kirigami.Units.smallSpacing
    rightPadding: background.border.width + Kirigami.Units.smallSpacing
    bottomPadding: background.border.width + Kirigami.Units.smallSpacing

    Behavior on implicitHeight {
        enabled: !root.visible

        SequentialAnimation {
            PropertyAction { targets: root; property: "_animating"; value: true }
            NumberAnimation { duration: Kirigami.Units.longDuration }
        }
    }

    onVisibleChanged: {
        if (!visible) {
            contentLayout.opacity = 0.0;
        }
    }

    opacity: visible ? 1.0 : 0.0

    Behavior on opacity {
        enabled: !root.visible

        NumberAnimation { duration: Kirigami.Units.shortDuration }
    }

    onOpacityChanged: {
        if (opacity == 0.0) {
            contentLayout.opacity = 0.0;
        } else if (opacity == 1.0) {
            contentLayout.opacity = 1.0;
        }
    }

    onImplicitHeightChanged: {
        height = implicitHeight;
    }
       contentItem: GridLayout {
        id: contentLayout

        // Used to defer opacity animation until we know if InlineMessage was
        // initialized visible.
        property bool complete: false

        Behavior on opacity {
            enabled: root.visible && contentLayout.complete

            SequentialAnimation {
                NumberAnimation { duration: Kirigami.Units.shortDuration * 2 }
                PropertyAction { targets: root; property: "_animating"; value: false }
            }
        }

        rowSpacing: Kirigami.Units.largeSpacing
        columnSpacing: Kirigami.Units.smallSpacing

        Kirigami.Icon {
            id: icon

            width: Kirigami.Units.iconSizes.smallMedium
            height: width

            Layout.alignment: text.lineCount > 1 ? Qt.AlignTop : Qt.AlignVCenter

            Layout.minimumWidth: width
            Layout.minimumHeight: height

            source: {
                if (root.icon.source) {
                    return root.icon.source;
                }

                if (root.type == Kirigami.MessageType.Positive) {
                    return "dialog-positive";
                } else if (root.type == Kirigami.MessageType.Warning) {
                    return "dialog-warning";
                } else if (root.type == Kirigami.MessageType.Error) {
                    return "dialog-error";
                }

                return "dialog-information";
            }

            color: root.icon.color
        }

        MouseArea {
            implicitHeight: text.implicitHeight

            Layout.fillWidth: true
            Layout.alignment: text.lineCount > 1 ? Qt.AlignTop : Qt.AlignVCenter
            Layout.row: 0
            Layout.column: 1

            cursorShape: text.hoveredLink ? Qt.PointingHandCursor : Qt.ArrowCursor

            Controls.Label {
                id: text

                width: parent.width

                color: Kirigami.Theme.textColor
                wrapMode: Text.WordWrap
                elide: Text.ElideRight

                text: root.text

                onLinkHovered: root.linkHovered(link)
                onLinkActivated: root.linkActivated(link)
            }
            //this must be child of an item which doesn't try to resize it
            TextMetrics {
                id: messageTextMetrics

                font: text.font
                text: text.text
            }
        }

        Kirigami.ActionToolBar {
            id: actionsLayout

            flat: false
            actions: root.actions
            visible: root.actions.length

            Layout.alignment: Qt.AlignRight

            Layout.row: {
                if (messageTextMetrics.width + Kirigami.Units.smallSpacing >
                    (contentLayout.width - icon.width - actionsLayout.width
                    - closeButton.width - (3 * contentLayout.columnSpacing))) {
                    return 1;
                }
                return 0;
            }
            Layout.column: Layout.row ? 0 : 2
            Layout.columnSpan: Layout.row ? (closeButton.visible ? 3 : 2) : 1
        }

        Controls.ToolButton {
            id: closeButton

            visible: root.showCloseButton

            Layout.alignment: text.lineCount > 1 || actionsLayout.Layout.row ? Qt.AlignTop : Qt.AlignVCenter
            Layout.row: 0
            Layout.column: actionsLayout.Layout.row ? 2 : 3

            //TODO: use toolbuttons icons when we can depend from Qt 5.10
            Kirigami.Icon {
                anchors.centerIn: parent
                source: "dialog-close"
                width: Kirigami.Units.iconSizes.smallMedium
                height: width
            }

            onClicked: root.visible = false
        }

        Component.onCompleted: complete = true
    }
}