ribboncustomizedata.h

浏览该文件的文档.

 
#pragma once
 
#include "qxribbon_global.h"
#include "ribbonactionsmanager.h"
#include "ribbongroup.h"
 
#include <QList>
 
QX_RIBBON_BEGIN_NAMESPACE
 
class RibbonBar;
 
class RibbonCustomizeData
{
public:
    enum ActionType {
        UnknowActionType = 0,          
        AddPageActionType,             
        AddGroupActionType,            
        AddActionActionType,           
        RemovePageActionType,          
        RemoveGroupActionType,         
        RemoveActionActionType,        
        ChangePageOrderActionType,     
        ChangeGroupOrderActionType,    
        ChangeActionOrderActionType,   
        RenamePageActionType,          
        RenameGroupActionType,         
        VisiblePageActionType,         
    };
public:
    RibbonCustomizeData();
    RibbonCustomizeData(ActionType type, RibbonActionsManager *mgr = Q_NULLPTR);
 
    // 获取CustomizeData的action type
    ActionType actionType() const;
 
    // 设置CustomizeData的action type
    void setActionType(ActionType a);
 
    // 判断是否是一个正常的CustomizeData
    bool isValid() const;
 
    // 应用RibbonCustomizeData
    bool apply(RibbonBar *bar);
 
    // 获取actionsmanager指针
    RibbonActionsManager *actionsManager();
 
    // 设置ActionsManager
    void setActionsManager(RibbonActionsManager *mgr);
 
    // 对应AddPageActionType
    static RibbonCustomizeData makeAddPageCustomizeData(const QString &title, int index, const QString &objName);
 
    // 对应AddGroupActionType
    static RibbonCustomizeData makeAddGroupCustomizeData(const QString &title, int index, const QString &pageObjName,
                                                         const QString &objName);
 
    // 对应AddActionActionType
    static RibbonCustomizeData makeAddActionCustomizeData(const QString &key, RibbonActionsManager *mgr,
                                                          RibbonGroup::RowProportion rp, const QString &pageObjName,
                                                          const QString &groupObjName);
 
    // 对应RenamePageActionType
    static RibbonCustomizeData makeRenamePageCustomizeData(const QString &newName, const QString &pageObjName);
 
    // 对应RenameGroupActionType
    static RibbonCustomizeData makeRenameGroupCustomizeData(const QString &newName, const QString &pageObjName,
                                                            const QString &groupObjName);
 
    // 对应RemovePageActionType
    static RibbonCustomizeData makeRemovePageCustomizeData(const QString &pageObjName);
 
    // 对应ChangePageOrderActionType
    static RibbonCustomizeData makeChangePageOrderCustomizeData(const QString &pageObjName, int moveIndex);
 
    // 对应ChangeGroupOrderActionType
    static RibbonCustomizeData makeChangeGroupOrderCustomizeData(const QString &pageObjName,
                                                                 const QString &groupObjName, int moveIndex);
 
    // 对应ChangeActionOrderActionType
    static RibbonCustomizeData makeChangeActionOrderCustomizeData(const QString &pageObjName,
                                                                  const QString &groupObjName, const QString &key,
                                                                  RibbonActionsManager *mgr, int moveIndex);
 
    // 对应RemoveGroupActionType
    static RibbonCustomizeData makeRemoveGroupCustomizeData(const QString &pageObjName, const QString &groupObjName);
 
    // 对应RemoveActionActionType
    static RibbonCustomizeData makeRemoveActionCustomizeData(const QString &pageObjName, const QString &groupObjName,
                                                             const QString &key, RibbonActionsManager *mgr);
 
    // 对应VisiblePageActionType
    static RibbonCustomizeData makeVisiblePageCustomizeData(const QString &pageObjName, bool isShow);
 
    // 判断是否可以自定义,如果某个action不想被编辑，可以通过此函数设置
    static bool isCanCustomize(QObject *obj);
    static void setCanCustomize(QObject *obj, bool canbe = true);
 
    // 对QList<RibbonCustomizeData>进行简化
    static QList<RibbonCustomizeData> simplify(const QList<RibbonCustomizeData> &csd);
public:
    int indexValue;
 
    QString keyValue;
 
    QString pageObjNameValue;
 
    QString groupObjNameValue;
 
    RibbonGroup::RowProportion actionRowProportionValue;
private:
    ActionType m_type;   
    RibbonActionsManager *m_actionsManager;
    bool customized;
};
 
typedef QList<RibbonCustomizeData> RibbonCustomizeDataList;
 
QX_RIBBON_END_NAMESPACE
 
Q_DECLARE_METATYPE(QX_RIBBON_PREPEND_NAMESPACE(RibbonCustomizeData))