controls/templates/Chip.qml

0001 // SPDX-FileCopyrightText: 2022 Felipe Kinoshita <kinofhek@gmail.com>
0002 // SPDX-License-Identifier: GPL-2.0-or-later
0003
0004 import QtQuick
0005 import QtQuick.Templates as T
0006
0007 /**
0008  * @brief Chip is a visual object based on AbstractButton
0009  * that provides a friendly way to display predetermined elements
0010  * with the visual styling of "tags" or "tokens."
0011  *
0012  * @see Chip
0013  * @since 2.19
0014  * @inherit QtQuick.Controls.AbstractButton
0015  */
0016 T.AbstractButton {
0017     id: chip
0018
0019     /**
0020      * @brief This property holds whether or not to display a close button.
0021      *
0022      * default: ``true``
0023      */
0024     property bool closable: true
0025
0026     /**
0027      * @brief This property holds whether the icon should be masked or not. This controls the Kirigami.Icon.isMask property.
0028      *
0029      * default: ``false``
0030      */
0031     property bool iconMask: false
0032
0033     /**
0034      * @brief This signal is emitted when the close button has been clicked.
0035      */
0036     signal removed()
0037 }