moduleobject.h

// SPDX-FileCopyrightText: 2018 - 2023 UnionTech Software Technology Co., Ltd.
//
// SPDX-License-Identifier: GPL-3.0-or-later
#ifndef DCC_MODULEOBJECT_H
#define DCC_MODULEOBJECT_H
 
#include "namespace.h"
 
#include <QIcon>
#include <QObject>
#include <QVariant>
 
using DCC_MODULE_TYPE = uint32_t;
 
#define DCC_MODULE_HIERARCHY_BIT 0x80000000
#define DCC_MODULE_GROUP_BIT 0x40000000
#define DCC_MODULE_LEAF_BIT 0x20000000
#define DCC_MODULE_LAYOUT_BIT 0x10000000
 
#define DCC_MODULE_LISTVIEW_BIT 0x08000000
#define DCC_MODULE_ITEM_BIT 0x04000000
#define DCC_MODULE_SETTINGSGROUP_BIT 0x02000000
#define DCC_MODULE_HORIZONTAL_BIT 0x01000000
#define DCC_MODULE_VERTICAL_BIT 0x00800000
 
#define DCC_MODULE_MAIN_BIT 0x00040000
#define DCC_MODULE_CUSTOM_BIT 0x00020000
 
namespace DCC_NAMESPACE {
enum : DCC_MODULE_TYPE {
    HIERARCHY_OBJECT = DCC_MODULE_HIERARCHY_BIT,
    LEAF_OBJECT = DCC_MODULE_LEAF_BIT,
    LISTVIEW = DCC_MODULE_GROUP_BIT | DCC_MODULE_LAYOUT_BIT | DCC_MODULE_LISTVIEW_BIT,
    ITEM = DCC_MODULE_LEAF_BIT | DCC_MODULE_ITEM_BIT,
    SETTINGSGROUP = DCC_MODULE_GROUP_BIT | DCC_MODULE_LAYOUT_BIT | DCC_MODULE_SETTINGSGROUP_BIT,
    HORIZONTAL = DCC_MODULE_GROUP_BIT | DCC_MODULE_LAYOUT_BIT | DCC_MODULE_HORIZONTAL_BIT,
    MAINLAYOUT = DCC_MODULE_GROUP_BIT | DCC_MODULE_LAYOUT_BIT | DCC_MODULE_MAIN_BIT,
    HLISTLAYOUT = DCC_MODULE_GROUP_BIT | DCC_MODULE_LAYOUT_BIT | DCC_MODULE_HORIZONTAL_BIT
            | DCC_MODULE_LISTVIEW_BIT,
    VLISTLAYOUT = DCC_MODULE_GROUP_BIT | DCC_MODULE_LAYOUT_BIT | DCC_MODULE_VERTICAL_BIT
            | DCC_MODULE_LISTVIEW_BIT,
    PAGELAYOUT = DCC_MODULE_GROUP_BIT | DCC_MODULE_LAYOUT_BIT | DCC_MODULE_VERTICAL_BIT,
    CUSTOM_OBJECT = DCC_MODULE_CUSTOM_BIT,
};
 
class ModuleObjectPrivate;
 
struct ModuleInitContext
{
    QString name;
    QString displayName;
    QStringList contentText;
    QVariant icon;
    QString description;
};
 
class ModuleObject : public QObject
{
    Q_OBJECT
    Q_PROPERTY(QString name READ name WRITE setName NOTIFY moduleDataChanged)
    Q_PROPERTY(QString displayName READ displayName WRITE setDisplayName NOTIFY displayNameChanged)
    Q_PROPERTY(QString description READ description WRITE setDescription NOTIFY moduleDataChanged)
    Q_PROPERTY(
            QStringList contentText READ contentText WRITE setContentText NOTIFY moduleDataChanged)
    Q_PROPERTY(QVariant icon READ icon WRITE setIcon NOTIFY moduleDataChanged)
    Q_PROPERTY(int badge READ badge WRITE setBadge NOTIFY moduleDataChanged)
 
    Q_PROPERTY(bool hidden READ isHidden WRITE setHidden NOTIFY stateChanged)
    Q_PROPERTY(bool disabled READ isDisabled WRITE setDisabled NOTIFY stateChanged)
 
public:
    explicit ModuleObject(QObject *parent = nullptr);
    explicit ModuleObject(const QString &name,
                          const QString &displayName = {},
                          QObject *parent = nullptr);
    explicit ModuleObject(const QString &name,
                          const QStringList &contentText,
                          QObject *parent = nullptr);
    explicit ModuleObject(const QString &name,
                          const QString &displayName,
                          const QStringList &contentText,
                          QObject *parent = nullptr);
    explicit ModuleObject(const QString &name,
                          const QString &displayName,
                          const QVariant &icon,
                          QObject *parent = nullptr);
    explicit ModuleObject(const QString &name,
                          const QString &displayName,
                          const QString &description,
                          QObject *parent = nullptr);
    explicit ModuleObject(const QString &name,
                          const QString &displayName,
                          const QString &description,
                          const QVariant &icon,
                          QObject *parent = nullptr);
    explicit ModuleObject(const QString &name,
                          const QString &displayName,
                          const QString &description,
                          const QIcon &icon,
                          QObject *parent = nullptr);
    explicit ModuleObject(const QString &name,
                          const QString &displayName,
                          const QString &description,
                          const QStringList &contentText,
                          const QVariant &icon,
                          QObject *parent = nullptr);
    explicit ModuleObject(const ModuleInitContext &message, QObject *parent = nullptr);
    virtual ~ModuleObject();
    virtual QWidget *activePage(bool autoActive = true);
 
public Q_SLOTS:
    virtual void active();
    virtual QWidget *page();
    virtual void deactive();
 
public:
    QString name() const;
    QString displayName() const;
    QString description() const;
    QStringList contentText() const;
    QVariant icon() const;
    int badge() const;
 
    bool isHidden() const;
    bool isVisible() const;
    bool isDisabled() const;
    bool isEnabled() const;
    bool getFlagState(uint32_t flag) const;
    uint32_t getFlag() const;
 
    // 扩展标志，在VList和Page布局中放在最下面，横向排列
    bool extra() const;
    void setExtra(bool value = true);
 
    // 是否参与搜索，默认参与搜索
    bool noSearch() const;
    void setNoSearch(bool noSearch = true);
 
    ModuleObject *currentModule() const;
    virtual ModuleObject *defultModule();
 
public Q_SLOTS:
    void setHidden(bool hidden);
    void setVisible(bool visible);
    void setDisabled(bool disabled);
    void setEnabled(bool enabled);
    void trigger();
 
    // 名称，作为每个模块的唯一标识，不可为空
    virtual void setName(const QString &name);
    // 显示名称，如菜单的名称，页面的标题等，为空则不显示
    virtual void setDisplayName(const QString &displayName);
    // 描述，如主菜单的描述信息
    virtual void setDescription(const QString &description);
    // 上下文数据，参与搜索，只可用于终结点：DisplayName -> ContentText(one of it)
    virtual void setContentText(const QStringList &contentText);
    virtual void addContentText(const QString &contentText);
    virtual void addContentText(const QStringList &contentText);
    // 图标，如主菜单的图标
    // 字符串类型,支持DDciIcon\QVariant,优先作为DDciIcon处理
    virtual void setIcon(const QVariant &icon);
    virtual void setIcon(const QIcon &icon);
    // 主菜单中的角标, 默认为0不显示，大于0显示
    virtual void setBadge(int badge);
    virtual void setFlagState(uint32_t flag, bool state);
    void setCurrentModule(ModuleObject *child);
 
Q_SIGNALS:
    void moduleDataChanged();
    void displayNameChanged(const QString &displayName);
    void stateChanged(uint32_t flag, bool state);
    void childStateChanged(ModuleObject *const child, uint32_t flag, bool state);
    void removedChild(ModuleObject *const module);
    void insertedChild(ModuleObject *const module);
    void childrenSizeChanged(const int size);
    void triggered();
    void currentModuleChanged(ModuleObject *currentModule);
 
    void visibleChanged();
 
public:
    ModuleObject *getParent();
    int findChild(ModuleObject *const child);
 
    static int findChild(ModuleObject *const module, ModuleObject *const child);
 
    inline bool hasChildrens() { return !childrens().isEmpty(); }
 
    const QList<ModuleObject *> &childrens();
    ModuleObject *children(const int index) const;
    int getChildrenSize() const;
 
    virtual void appendChild(ModuleObject *const module);
    virtual void removeChild(ModuleObject *const module);
    virtual void removeChild(const int index);
    virtual void insertChild(QList<ModuleObject *>::iterator before, ModuleObject *const module);
    virtual void insertChild(const int index, ModuleObject *const module);
 
    static unsigned GetCurrentVersion();
    static bool IsVisible(DCC_NAMESPACE::ModuleObject *const module);
    static bool IsHidden(DCC_NAMESPACE::ModuleObject *const module);
    static bool IsHiddenFlag(uint32_t flag);
    static bool IsEnabled(DCC_NAMESPACE::ModuleObject *const module);
    static bool IsDisabled(DCC_NAMESPACE::ModuleObject *const module);
    static bool IsDisabledFlag(uint32_t flag);
 
    inline virtual DCC_MODULE_TYPE getClassID() const { return HIERARCHY_OBJECT; }
 
private:
    static int findChild(ModuleObject *const module, ModuleObject *const child, const int num);
    DCC_DECLARE_PRIVATE(ModuleObject)
};
 
} // namespace DCC_NAMESPACE
 
#endif // DCC_MODULEOBJECT_H