/*
 *  SPDX-FileCopyrightText: 2016 Marco Martin <mart@kde.org>
 *  SPDX-FileCopyrightText: 2023 ivan tkachenko <me@ratijas.tk>
 *
 *  SPDX-License-Identifier: LGPL-2.0-or-later
 */

import QtQml
import QtQuick
import QtQuick.Controls as QQC2
import QtQuick.Templates as T
import org.kde.kirigami as Kirigami
import org.kde.kirigami.private as P

/*!
  \qmltype Action
  \inqmlmodule org.kde.kirigami

  \brief An item that represents an abstract Action.
 */
QQC2.Action {
//BEGIN properties
    /*!
      \brief This property holds whether the graphic representation of the action
      is supposed to be visible.

      It's up to the action representation to honor this property.

      default: \c true
     */
    property bool visible: !fromQAction || fromQAction.visible

    /*!
      \brief This property holds the tooltip text that is shown when the cursor is hovering over the control.

      Leaving this undefined or setting it to an empty string means that no tooltip will be shown when
      the cursor is hovering over the control that triggers the tooltip.
      \warning Tooltips may not be supported on all platforms.
     */
    property string tooltip

    /*!
      \brief This property sets whether this action is a separator action.

      default: \c false
     */
    property bool separator: false

    /*!
       \brief This property holds whether auto-exclusivity is enabled.

       If auto-exclusivity is enabled, checkable actions that belong to the
       same parent item behave as if they were part of the same ButtonGroup.
       Only one action can be checked at any time; checking another action
       automatically unchecks the previously checked one.

       default: \c false
     */
    property bool autoExclusive: false

    /*!
      \brief This property sets whether this action  becomes a title displaying
      its child actions as sub-items in GlobalDrawers and ContextDrawers.

      default: \c false

      \since 2.6
     */
    property bool expandible: false

    /*!
      \qmlproperty Action parent
      \brief This property holds the parent action.
     */
    property T.Action parent

    /*!
      \qmlproperty enumeration Action::displayHint

      \brief This property sets this action's display type.

      These are provided to implementations to indicate a preference for certain display
      styles.

      default: \c Kirigami.DisplayHint.NoPreference

      \note This property contains only preferences, implementations may choose to disregard them.
      \sa DisplayHint
      \since 2.12
     */
    property int displayHint: Kirigami.DisplayHint.NoPreference

    /*!
      \brief This property holds the component that should be used for displaying this action.
      \note This can be used to display custom components in the toolbar.
      \since 5.65
     */
    property Component displayComponent

    /*!
      \qmlproperty list<Action> children
      \brief This property holds a list of child actions.

      This is useful for tree-like menus, such as the GlobalDrawer.

      Example usage:
      \code
      import QtQuick.Controls as QQC2
      import org.kde.kirigami as Kirigami

      Kirigami.Action {
         text: "Tools"

         QQC2.Action {
             text: "Action1"
         }
         Kirigami.Action {
             text: "Action2"
         }
      }
      \endcode
     */
    default property list<T.Action> children

    /*!
      This property holds a QAction.

      When provided Kirigami.Action will be initialized from the given QAction.

      \since Kirigami 6.4
     */
    property QtObject fromQAction
//END properties

    onChildrenChanged: {
        children
            .filter(action => action instanceof Kirigami.Action)
            .forEach(action => {
                action.parent = this;
            });
    }

    /*!
      \qmlproperty list<Action> visibleChildren
      \brief This property holds the action's visible child actions.
     */
    readonly property list<T.Action> visibleChildren: children
        .filter(action => !(action instanceof Kirigami.Action) || action.visible)

    shortcut: fromQAction?.shortcut
    text: fromQAction?.text ?? ''
    icon.name: fromQAction ? P.ActionHelper.iconName(fromQAction.icon) : ''
    onTriggered: if (fromQAction) {
        fromQAction.trigger();
    }
    checkable: fromQAction?.checkable ?? false
    checked: fromQAction?.checked ?? false
    enabled: !fromQAction || fromQAction.enabled

    readonly property Shortcut alternateShortcut : Shortcut {
        sequences: P.ActionHelper.alternateShortcuts(fromQAction)
        onActivated: root.trigger()
    }
}