RibbonActionsManager.h

//
// Created by weiwu on 21-5-2.
//

#ifndef RIBBON_RIBBONACTIONSMANAGER_H
#define RIBBON_RIBBONACTIONSMANAGER_H


#include <QtCore/QObject>
#include <QtWidgets/QAction>
#include "RibbonCategory.h"
#include "RibbonMainWindow.h"

class RibbonActionsManagerPrivate;

class RibbonActionsModelPrivate;

class RibbonActionsManager : public QObject {
Q_OBJECT

    friend class RibbonActionsManagerModel;

public:

    /**
     * @brief 定义action的标签
     */
    enum ActionTag {
        UnknowActionTag = 0             ///< 未知的tag
        ,
        CommonlyUsedActionTag = 0x01          ///< 预设tag-常用命令
        ,
        NotInFunctionalAreaActionTag = 0x02          ///< 预设tag-不在功能区命令
        ,
        AutoCategoryDistinguishBeginTag = 0x1000        ///< 自动按Category划分的标签起始，在@ref autoRegisteActions 函数会用到
        ,
        AutoCategoryDistinguishEndTag = 0x2000        ///< 自动按Category划分的标签结束，在@ref autoRegisteActions 函数会用到
        ,
        NotInRibbonCategoryTag = 0x2001        ///< 不在功能区的标签@ref autoRegisteActions 函数会遍历所有category的action以及RibbonMainWindow下的action，如果两个
        ,
        UserDefineActionTag = 0x8000        ///< 自定义标签，所有用户自定义tag要大于此tag
    };

    RibbonActionsManager(QObject *p = nullptr);

    ~RibbonActionsManager();

    //设置tag对应的名字
    void setTagName(int tag, const QString &name);

    //获取tag对应的名字
    QString tagName(int tag) const;

    //移除tag，注意，这个函数非常耗时
    void removeTag(int tag);

    //注册action
    bool registeAction(QAction *act, int tag, const QString &key = QString(), bool enableEmit = true);

    //取消action的注册
    void unregisteAction(QAction *act, bool enableEmit = true);

    //过滤得到actions对应的引用，实际是一个迭代器
    QList<QAction *> &filter(int tag);

    //通过tag筛选出系列action
    QList<QAction *> &actions(int tag);

    const QList<QAction *> actions(int tag) const;

    //获取所有的标签
    QList<int> actionTags() const;

    //通过key获取action
    QAction *action(const QString &key) const;

    //通过action找到key
    QString key(QAction *act) const;

    //返回所有管理的action数
    int count() const;

    //返回所有管理的actions
    QList<QAction *> allActions() const;

    //自动加载action,返回tag对应的Category指针
    QMap<int, RibbonCategory *> autoRegisteActions(RibbonMainWindow *w);

    //自动加载widget下的actions函数返回的action,返回加载的数量，这些
    QSet<QAction *> autoRegisteWidgetActions(QWidget *w, int tag, bool enableEmit = false);

    //根据标题查找action
    QList<QAction *> search(const QString &text);

signals:

    /**
     * @brief 标签变化触发的信号，变化包括新增和删除
     */
    void actionTagChanged(int tag, bool isdelete);

private slots:

    void onActionDestroyed(QObject *o);

    void onCategoryTitleChanged(const QString &title);

private:
    void removeAction(QAction *act, bool enableEmit = true);

private:
    RibbonActionsManagerPrivate *m_d;
};

class RibbonActionsManagerModel : public QAbstractListModel {
Q_OBJECT
public:
    explicit RibbonActionsManagerModel(QObject *p = nullptr);

    explicit RibbonActionsManagerModel(RibbonActionsManager *m, QObject *p = nullptr);

    ~RibbonActionsManagerModel();

    virtual int rowCount(const QModelIndex &parent) const override;

    virtual QVariant headerData(int section, Qt::Orientation orientation, int role = Qt::DisplayRole) const override;

    virtual Qt::ItemFlags flags(const QModelIndex &index) const override;

    virtual QVariant data(const QModelIndex &index, int role) const override;

    void setFilter(int tag);

    void update();

    void setupActionsManager(RibbonActionsManager *m);

    void uninstallActionsManager();

    QAction *indexToAction(QModelIndex index) const;

    void search(const QString &text);

private slots:

    void onActionTagChanged(int tag, bool isdelete);

private:
    RibbonActionsModelPrivate *m_d;
};

#endif //RIBBON_RIBBONACTIONSMANAGER_H