File indexing completed on 2024-12-22 04:41:14

0001 /* ============================================================
0002 * Falkon - Qt web browser
0003 * Copyright (C) 2018 Anmol Gautam <tarptaeya@gmail.com>
0004 *
0005 * This program is free software: you can redistribute it and/or modify
0006 * it under the terms of the GNU General Public License as published by
0007 * the Free Software Foundation, either version 3 of the License, or
0008 * (at your option) any later version.
0009 *
0010 * This program is distributed in the hope that it will be useful,
0011 * but WITHOUT ANY WARRANTY; without even the implied warranty of
0012 * MERCHANTABILITY or FITNESS FOR A PARTICULAR PURPOSE.  See the
0013 * GNU General Public License for more details.
0014 *
0015 * You should have received a copy of the GNU General Public License
0016 * along with this program.  If not, see <http://www.gnu.org/licenses/>.
0017 * ============================================================ */
0018 #pragma once
0019 
0020 #include <QObject>
0021 #include <QAction>
0022 #include <QVariantMap>
0023 
0024 class QmlEngine;
0025 
0026 /**
0027  * @brief The class exposing Action API to QML
0028  */
0029 class QmlAction : public QObject
0030 {
0031     Q_OBJECT
0032 public:
0033     explicit QmlAction(QAction *action, QmlEngine *engine, QObject *parent = nullptr);
0034     void setProperties(const QVariantMap &map);
0035     /**
0036      * @brief Updates the properties of the action
0037      * @param A JavaScript object containing the updated properties of the action.
0038      */
0039     Q_INVOKABLE void update(const QVariantMap &map);
0040 
0041 Q_SIGNALS:
0042     /**
0043      * @brief This signal is emitted when the action is triggered.
0044      */
0045     void triggered();
0046 
0047 private:
0048     QAction *m_action = nullptr;
0049     QString m_pluginPath;
0050 };