SARibbonBar.h

#ifndef SARIBBONBAR_H
#define SARIBBONBAR_H
#include "SARibbonCategory.h"
#include "SARibbonContextCategory.h"
#include "SARibbonGlobal.h"
#include <QMenuBar>
#include <QScopedPointer>
#include <QVariant>
 
class QAction;
class QAbstractButton;
class SARibbonElementFactory;
class SARibbonTabBar;
class SARibbonButtonGroupWidget;
class SARibbonQuickAccessBar;
class SARibbonStackedWidget;
class SARibbonTitleIconWidget;
 
class SA_RIBBON_EXPORT SARibbonBar : public QMenuBar
{
    Q_OBJECT
    SA_RIBBON_DECLARE_PRIVATE(SARibbonBar)
    friend class SARibbonMainWindow;
    friend class SARibbonSystemButtonBar;
    Q_PROPERTY(RibbonStyles ribbonStyle READ currentRibbonStyle WRITE setRibbonStyle)
    Q_PROPERTY(bool minimumMode READ isMinimumMode WRITE setMinimumMode)
    Q_PROPERTY(bool minimumModeButton READ haveShowMinimumModeButton WRITE showMinimumModeButton)
    Q_PROPERTY(QColor windowTitleTextColor READ windowTitleTextColor WRITE setWindowTitleTextColor)
    Q_PROPERTY(QColor tabBarBaseLineColor READ tabBarBaseLineColor WRITE setTabBarBaseLineColor)
    Q_PROPERTY(Qt::Alignment windowTitleAligment READ windowTitleAligment WRITE setWindowTitleAligment)
    Q_PROPERTY(bool enableWordWrap READ isEnableWordWrap WRITE setEnableWordWrap)
    Q_PROPERTY(bool enableShowPanelTitle READ isEnableShowPanelTitle WRITE setEnableShowPanelTitle)
    Q_PROPERTY(bool tabOnTitle READ isTabOnTitle WRITE setTabOnTitle)
    Q_PROPERTY(SARibbonPanel::PanelLayoutMode panelLayoutMode READ panelLayoutMode WRITE setPanelLayoutMode)
 
public:
    enum RibbonStyleFlag
    {
        RibbonStyleLoose    = 0x0001,  // bit:0000 0001
        RibbonStyleCompact  = 0x0002,  // bit:0000 0010
        RibbonStyleThreeRow = 0x0010,  // bit:0001 0000
        RibbonStyleTwoRow   = 0x0020,  // bit:0010 0000
 
        RibbonStyleLooseThreeRow   = RibbonStyleLoose | RibbonStyleThreeRow,    
        RibbonStyleCompactThreeRow = RibbonStyleCompact | RibbonStyleThreeRow,  
        RibbonStyleLooseTwoRow     = RibbonStyleLoose | RibbonStyleTwoRow,      
        RibbonStyleCompactTwoRow   = RibbonStyleCompact | RibbonStyleTwoRow     
    };
    Q_ENUM(RibbonStyleFlag)
    Q_DECLARE_FLAGS(RibbonStyles, RibbonStyleFlag)
    Q_FLAG(RibbonStyles)
 
    
    enum RibbonMode
    {
        MinimumRibbonMode,  
        NormalRibbonMode    
    };
    Q_ENUM(RibbonMode)
public:
    using FpCategoryIterate = std::function< bool(SARibbonCategory*) >;
    using FpPanelIterate    = SARibbonCategory::FpPanelIterate;
    using FpContextCategoryHighlight = std::function< QColor(const QColor&) >;
 
public:
    // 判断RibbonStyle是否为2行模式
    static bool isTwoRowStyle(RibbonStyles s);
    static bool isThreeRowStyle(RibbonStyles s);
    // 判断是否是office样式
    static bool isLooseStyle(RibbonStyles s);
    static bool isCompactStyle(RibbonStyles s);
    // 获取版本信息
    static QString versionString();
 
    // 获取默认的上下文标签颜色列表
    static QList< QColor > defaultContextCategoryColorList();
 
    // 初始化高分辨率适配
    static void initHighDpi();
 
public:
    // 构造函数
    explicit SARibbonBar(QWidget* parent = nullptr);
    ~SARibbonBar();
    // 获取applicationButton
    QAbstractButton* applicationButton();
 
    // 设置applicationButton
    void setApplicationButton(QAbstractButton* btn);
 
    // 获取tabbar
    SARibbonTabBar* ribbonTabBar();
 
    // 添加一个标签
    SARibbonCategory* addCategoryPage(const QString& title);
    void addCategoryPage(SARibbonCategory* category);
 
    // 为了支持Qt designer,添加的一个重载函数
    Q_INVOKABLE void addCategoryPage(QWidget* category);
 
    // 添加一个category，category的位置在index，如果当前category数量少于index，将插入到最后
    SARibbonCategory* insertCategoryPage(const QString& title, int index);
    void insertCategoryPage(SARibbonCategory* category, int index);
 
    // 通过名字查找Category
    SARibbonCategory* categoryByName(const QString& title) const;
 
    // 通过ObjectName查找Category
    SARibbonCategory* categoryByObjectName(const QString& objname) const;
 
    // 通过索引找到category，如果超过索引范围，会返回nullptr
    SARibbonCategory* categoryByIndex(int index) const;
 
    // 隐藏category,并不会删除或者取走，只是隐藏
    void hideCategory(SARibbonCategory* category);
 
    // 显示被隐藏的category
    void showCategory(SARibbonCategory* category);
 
    // 判断这个category是否在显示状态，也就是tabbar有这个category
    bool isCategoryVisible(const SARibbonCategory* c) const;
 
    // 获取category的索引
    int categoryIndex(const SARibbonCategory* c) const;
 
    // 移动一个Category从from index到to index
    void moveCategory(int from, int to);
 
    // 获取当前显示的所有的SARibbonCategory，包含未显示的SARibbonContextCategory的SARibbonCategory也一并返回
    QList< SARibbonCategory* > categoryPages(bool getAll = true) const;
 
    // 移除SARibbonCategory
    void removeCategory(SARibbonCategory* category);
 
    // 添加一个上下文标签
    SARibbonContextCategory*
    addContextCategory(const QString& title, const QColor& color = QColor(), const QVariant& id = QVariant());
    void addContextCategory(SARibbonContextCategory* context);
 
    // 显示一个上下文标签
    void showContextCategory(SARibbonContextCategory* context);
 
    // 隐藏一个上下文标签
    void hideContextCategory(SARibbonContextCategory* context);
 
    // 判断上下文是否是在显示状态
    bool isContextCategoryVisible(SARibbonContextCategory* context);
 
    // 设置上下文标签的显示或隐藏
    void setContextCategoryVisible(SARibbonContextCategory* context, bool visible);
 
    // 获取所有的上下文标签
    QList< SARibbonContextCategory* > contextCategoryList() const;
 
    // 移除ContextCategory
    void destroyContextCategory(SARibbonContextCategory* context);
 
    // 获取当前可见的上下文标签的tab索引
    QList< int > currentVisibleContextCategoryTabIndexs() const;
 
    // 设置为隐藏模式
    void setMinimumMode(bool isHide);
 
    // 当前Ribbon是否是隐藏模式
    bool isMinimumMode() const;
 
    // 设置显示隐藏ribbon按钮
    void showMinimumModeButton(bool isShow = true);
 
    // 是否显示隐藏ribbon按钮
    bool haveShowMinimumModeButton() const;
 
    // 隐藏ribbon对应的action
    QAction* minimumModeAction() const;
 
    // tab双击后最小化ribbon
    bool isEnableTabDoubleClickToMinimumMode() const;
    void setTabDoubleClickToMinimumMode(bool on = true) const;
 
    // 当前的模式
    RibbonMode currentRibbonState() const;
 
    // ribbon tab的高度
    int tabBarHeight() const;
    void setTabBarHeight(int h, bool resizeByNow = true);
 
    // 标题栏的高度
    int titleBarHeight() const;
    void setTitleBarHeight(int h, bool resizeByNow = true);
 
    // category的高度
    int categoryHeight() const;
    void setCategoryHeight(int h, bool resizeByNow = true);
 
    // 获取正常模式下的mainBar的高度
    int normalModeMainBarHeight() const;
 
    // 最小模式下的MainBar高度
    int minimumModeMainBarHeight() const;
 
    // 激活tabbar右边的按钮群
    SARibbonButtonGroupWidget* activeRightButtonGroup();
 
    // 右侧按钮群
    SARibbonButtonGroupWidget* rightButtonGroup();
 
    // 激活QuickAccessBar
    SARibbonQuickAccessBar* activeQuickAccessBar();
 
    // 快速响应栏
    SARibbonQuickAccessBar* quickAccessBar();
 
    // 标题栏窗口
    SARibbonTitleIconWidget* titleIconWidget() const;
 
    //  设置标题图标显示
    void setTitleIconVisible(bool on = true);
    // 图标是否显示
    bool isTitleIconVisible() const;
 
    // 设置ribbon的风格
    void setRibbonStyle(RibbonStyles v);
    RibbonStyles currentRibbonStyle() const;
 
    // 设置当前ribbon的index
    void setCurrentIndex(int index);
 
    // 返回当前的tab索引
    int currentIndex();
 
    // 确保标签显示出来
    void raiseCategory(SARibbonCategory* category);
 
    // 判断当前的行数
    bool isTwoRowStyle() const;
    bool isThreeRowStyle() const;
 
    // 判断当前的样式
    bool isLooseStyle() const;
    bool isCompactStyle() const;
 
    // 更新ribbon的布局数据，此函数适用于一些关键性尺寸变化，换起ribbon下面元素的布局,在发现刷新问题时，可以调用此函数
    void updateRibbonGeometry();
 
    // 设置panel的模式
    SARibbonPanel::PanelLayoutMode panelLayoutMode() const;
    void setPanelLayoutMode(SARibbonPanel::PanelLayoutMode m);
 
    // 设置tab在title上面，这样可以省略title区域
    void setTabOnTitle(bool on);
    bool isTabOnTitle() const;
 
    // tabbar 底部会绘制一条线条，此接口定义线条颜色
    void setTabBarBaseLineColor(const QColor& clr);
    QColor tabBarBaseLineColor() const;
 
    // 设置标题颜色
    void setWindowTitleTextColor(const QColor& clr);
    QColor windowTitleTextColor() const;
 
    // 设置是否显示标题
    void setTitleVisible(bool on = false);
    bool isTitleVisible() const;
 
    // 设置标题的背景颜色
    void setWindowTitleBackgroundBrush(const QBrush& bk);
    QBrush windowTitleBackgroundBrush() const;
 
    // 设置标题的对齐方式
    void setWindowTitleAligment(Qt::Alignment al);
    Qt::Alignment windowTitleAligment() const;
 
    // 设置按钮允许换行，注意图标大小是由文字决定的，两行文字会让图标变小，如果想图标变大，文字不换行是最好的
    void setEnableWordWrap(bool on);
    bool isEnableWordWrap() const;
 
    // 按钮的最大宽高比，这个系数决定按钮的最大宽度，系数越大，按钮能显示的越宽
    void setButtonMaximumAspectRatio(qreal fac = 1.4);
    qreal buttonMaximumAspectRatio() const;
 
    // 设置panel的标题栏高度
    void setPanelTitleHeight(int h);
    int panelTitleHeight() const;
 
    // 设置panel是否显示标题栏
    void setEnableShowPanelTitle(bool on);
    bool isEnableShowPanelTitle() const;
 
    // 设置panel的spacing
    void setPanelSpacing(int n);
    int panelSpacing() const;
 
    // 设置panel按钮的icon尺寸,第一个参数为小图标尺寸，第二个参数为大图标尺寸
    void setPanelToolButtonIconSize(const QSize& smallSize, const QSize& largeSize);
    QPair< QSize, QSize > panelToolButtonIconSize() const;
 
    // 大按钮图标尺寸
    void setPanelLargeIconSize(const QSize& largeSize);
    QSize panelLargeIconSize() const;
 
    // 小按钮图标尺寸
    void setPanelSmallIconSize(const QSize& smallSize);
    QSize panelSmallIconSize() const;
 
    // 获取SARibbonStackedWidget，谨慎使用此函数
    SARibbonStackedWidget* ribbonStackedWidget();
 
    // 上下文标签的颜色列表，上下文标签显示的时候，会从颜色列表中取颜色进行标签的渲染
    void setContextCategoryColorList(const QList< QColor >& cls);
    QList< QColor > contextCategoryColorList() const;
 
    // 设置context category 标题的文字颜色
    void setContextCategoryTitleTextColor(const QColor& clr);
    QColor contextCategoryTitleTextColor() const;
 
    // 设置上下文标签颜色的高亮方法
    void setContextCategoryColorHighLight(FpContextCategoryHighlight fp);
 
    // 设置ribbon的对齐方式
    void setRibbonAlignment(SARibbonAlignment al);
    SARibbonAlignment ribbonAlignment() const;
 
    // 此函数会遍历SARibbonBar下的所有Category，执行函数指针(bool(SARibbonCategory*))，函数指针返回false则停止迭代
    bool iterateCategory(FpCategoryIterate fp) const;
    // 此函数会遍历SARibbonBar下的所有Category,并迭代所有的panel，执行函数指针(bool(SARibbonPanel*))，函数指针返回false则停止迭代
    bool iteratePanel(FpPanelIterate fp) const;
 
    // 设置边角widget可见性，对于mdi窗口，会出现TopLeftCorner和TopRightCorner两个corner widget
    void setCornerWidgetVisible(bool on, Qt::Corner c = Qt::TopLeftCorner);
 
    // 设置ApplicationButton垂直方向扩充，这样ApplicationButton能占用标题栏和tab栏两个栏的高度
    void setApplicationButtonVerticalExpansion(bool on = true);
    bool isApplicationButtonVerticalExpansion() const;
 
    // 获取所有panel下的action
    QList< QAction* > allActions() const;
    // 当前是否使用的无边框
    bool isUseRibbonFrame() const;
Q_SIGNALS:
 
    void applicationButtonClicked();
 
    void currentRibbonTabChanged(int index);
 
    void ribbonModeChanged(SARibbonBar::RibbonMode nowState);
 
    void ribbonStyleChanged(SARibbonBar::RibbonStyles nowStyle);
 
    void titleBarHeightChanged(int oldHeight, int newHeight);
 
    void actionTriggered(QAction* action);
 
protected:
    bool eventFilter(QObject* obj, QEvent* e) override;
    // 根据情况重置tabbar的宽度，主要针对wps模式
    int calcMinTabBarWidth() const;
    // 更新
    void updateCategoryTitleToTabName();
    // 告知WindowButtonGroup的尺寸
    void setSystemButtonGroupSize(const QSize& s);
    // 设置当前的MainWindow的样式，这个函数是SARibbonMainWindow调用，告知ribbonbar当前MainWindow的样式
    void setMainWindowStyles(SARibbonMainWindowStyles s);
protected Q_SLOTS:
    void onWindowTitleChanged(const QString& title);
    void onWindowIconChanged(const QIcon& i);
    void onCategoryWindowTitleChanged(const QString& title);
    void onStackWidgetHided();
    virtual void onCurrentRibbonTabChanged(int index);
    virtual void onCurrentRibbonTabClicked(int index);
    virtual void onCurrentRibbonTabDoubleClicked(int index);
    void onContextsCategoryPageAdded(SARibbonCategory* category);
    void onContextsCategoryCategoryNameChanged(SARibbonCategory* category, const QString& title);
    void onTabMoved(int from, int to);
 
private:
    int tabIndex(SARibbonCategory* obj);
    void paintInLooseStyle();
    void paintInCompactStyle();
 
    // 刷新所有ContextCategoryManagerData，这个在单独一个Category删除时调用
    void updateContextCategoryManagerData();
    void synchronousCategoryData(bool autoUpdate = true);
    // 把窗口标题文字转换为显示的文字，这里主要针对[*]占位符进行替换
    QString toDisplayTitleText(const QString& title) const;
    // 获取标题显示的区域
    QRect getWindowTitleRect() const;
 
protected:
    void setRibbonMainwindowStyle();
    virtual void paintEvent(QPaintEvent* e) override;
    virtual void moveEvent(QMoveEvent* e) override;
    virtual void changeEvent(QEvent* e) override;
 
    virtual void paintTabbarBaseLine(QPainter& painter);
    virtual void paintWindowTitle(QPainter& painter, const QString& title, const QRect& titleRegion);
    virtual void
    paintContextCategoryTab(QPainter& painter, const QString& title, const QRect& contextRect, const QColor& color);
#if SA_DEBUG_PRINT_SARIBBONBAR
    SA_RIBBON_EXPORT friend QDebug operator<<(QDebug debug, const SARibbonBar& ribbon);
#endif
};
Q_DECLARE_OPERATORS_FOR_FLAGS(SARibbonBar::RibbonStyles)
 
#endif  // SARIBBONBAR_H