SARibbonPanel.h

#ifndef SARIBBONPANEL_H
#define SARIBBONPANEL_H
#include "SARibbonGlobal.h"
#include "SARibbonPanelItem.h"
#include "SARibbonToolButton.h"
#include <QLayout>
#include <QWidget>
#include <QLabel>
class SARibbonMenu;
class SARibbonGallery;
class QGridLayout;
class SARibbonPanelOptionButton;
class SARibbonPanelLayout;
class SARibbonCategory;
class SARibbonBar;
 
class SA_RIBBON_EXPORT SARibbonPanelLabel : public QLabel
{
    Q_OBJECT
public:
    SARibbonPanelLabel(QWidget* parent = nullptr);
};
 
class SA_RIBBON_EXPORT SARibbonPanel : public QFrame
{
    Q_OBJECT
    SA_RIBBON_DECLARE_PRIVATE(SARibbonPanel)
    friend class SARibbonBar;
    friend class SARibbonCategory;
    friend class SARibbonCategoryPrivate;
    friend class SARibbonCustomizeWidgetPrivate;
    friend class SARibbonPanelLayout;
    Q_PROPERTY(bool isCanCustomize READ isCanCustomize WRITE setCanCustomize)
    Q_PROPERTY(bool isExpanding READ isExpanding WRITE setExpanding)
    Q_PROPERTY(QString panelName READ panelName WRITE setPanelName)
public:
    enum PanelLayoutMode
    {
        ThreeRowMode,
 
        TwoRowMode
    };
    Q_ENUM(PanelLayoutMode)
public:
    using FpRibbonToolButtonIterate = std::function< bool(SARibbonToolButton*) >;
 
public:
    explicit SARibbonPanel(QWidget* parent = nullptr);
    explicit SARibbonPanel(const QString& name, QWidget* parent = nullptr);
    ~SARibbonPanel() Q_DECL_OVERRIDE;
    using QWidget::addAction;
 
    // 把action加入到panel
    void addAction(QAction* action, SARibbonPanelItem::RowProportion rowProportion);
    // 生成并添加一个action
    void addAction(QAction* act,
                   QToolButton::ToolButtonPopupMode popMode,
                   SARibbonPanelItem::RowProportion rowProportion = SARibbonPanelItem::Large);
    // 把action加入到panel，并以大图标显示
    void addLargeAction(QAction* action);
    // 把action加入到panel，在三行模式下会以中图标显示
    void addMediumAction(QAction* action);
    // 把action加入到panel，并以小图标显示
    void addSmallAction(QAction* action);
 
    // 把action加入到panel，并以小图标显示
    void addSmallAction(QAction* action, QToolButton::ToolButtonPopupMode popMode);
    // 把action加入到panel，并以大图标显示
    void addLargeAction(QAction* action, QToolButton::ToolButtonPopupMode popMode);
    // 把action加入到panel，在三行模式下会以中图标显示
    void addMediumAction(QAction* action, QToolButton::ToolButtonPopupMode popMode);
    // 生成并添加一个action
    QAction* addAction(const QString& text,
                       const QIcon& icon,
                       QToolButton::ToolButtonPopupMode popMode,
                       SARibbonPanelItem::RowProportion rowProportion = SARibbonPanelItem::Large);
 
    // 添加menu
    void addMenu(QMenu* menu,
                 SARibbonPanelItem::RowProportion rowProportion,
                 QToolButton::ToolButtonPopupMode popMode = QToolButton::InstantPopup);
    // 添加普通大菜单
    void addLargeMenu(QMenu* menu, QToolButton::ToolButtonPopupMode popMode = QToolButton::InstantPopup);
    // 添加普通小按钮菜单
    void addMediumMenu(QMenu* menu, QToolButton::ToolButtonPopupMode popMode = QToolButton::InstantPopup);
    // 添加普通小按钮菜单
    void addSmallMenu(QMenu* menu, QToolButton::ToolButtonPopupMode popMode = QToolButton::InstantPopup);
 
    // 添加窗口
    QAction* addWidget(QWidget* w, SARibbonPanelItem::RowProportion rowProportion);
 
    // 添加窗口,占用ribbon的一行
    QAction* addSmallWidget(QWidget* w);
 
    // 添加窗口,占用ribbon的一行
    QAction* addMediumWidget(QWidget* w);
 
    // 添加窗口，占用所有行
    QAction* addLargeWidget(QWidget* w);
 
    // 添加一个Gallery
    SARibbonGallery* addGallery(bool expanding = true);
 
    // 添加分割线
    QAction* addSeparator();
 
    // 从panel中把action对应的button提取出来，如果action没有对应的button，就返回nullptr
    SARibbonToolButton* actionToRibbonToolButton(QAction* action);
 
    // 设置操作action，如果要去除，传入nullptr指针即可，SARibbonPanel不会对QAction的所有权进行管理
    // OptionAction也会触发actionTriggered信号
    void setOptionAction(QAction* action);
 
    // 判断是否存在OptionAction
    bool isHaveOptionAction() const;
 
    // 获取所有的buttons
    QList< SARibbonToolButton* > ribbonToolButtons() const;
 
    // 获取PanelLayoutMode
    PanelLayoutMode panelLayoutMode() const;
    void setPanelLayoutMode(PanelLayoutMode mode);
 
    // 更新按钮的尺寸，这个函数在panel的布局状态变换后需要调用刷新
    void resetToolButtonSize();
 
    // 判断是否为2行模式
    bool isTwoRow() const;
 
    // 把panel设置为扩展模式，此时会撑大水平区域
    void setExpanding(bool isExpanding = true);
    // 是否是扩展模式
    bool isExpanding() const;
 
    // 标题栏高度
    int titleHeight() const;
 
    // 是否显示标题，显示标题后，标题的高度需要设置，默认高度为15
    bool isEnableShowTitle() const;
 
    // action对应的布局index，此操作一般用于移动moveAction，其他意义不大
    int actionIndex(QAction* act) const;
 
    // 移动action
    void moveAction(int from, int to);
 
    // 判断是否可以自定义
    bool isCanCustomize() const;
    void setCanCustomize(bool b);
 
    // 标题
    QString panelName() const;
    void setPanelName(const QString& title);
 
    // 大图标的高度
    int largeButtonHeight() const;
 
    // 获取布局对应的item,此函数目前仅仅在自定义过程中用到
    const QList< SARibbonPanelItem* >& ribbonPanelItem() const;
 
    // 获取panel layout
    SARibbonPanelLayout* panelLayout() const;
 
    // 更新布局
    void updateItemGeometry();
 
    // 获取category指针，如果没有parent，或者不在category管理，返回nullptr
    SARibbonCategory* category() const;
 
    // 获取ribbonBar指针，如果没有返回nullptr
    SARibbonBar* ribbonBar() const;
 
    // 按钮之间的间隔
    int spacing() const;
 
    // 设置按钮的icon尺寸，large action不受此尺寸影响
    void setToolButtonIconSize(const QSize& s);
    QSize toolButtonIconSize() const;
 
    // 获取最近添加的按钮
    SARibbonToolButton* lastAddActionButton();
 
    // 获取panel标题的label控件
    SARibbonPanelLabel* titleLabel() const;
 
    // 是否允许换行
    bool isEnableWordWrap() const;
 
    // 按钮的最大宽高比，这个系数决定按钮的最大宽度
    qreal buttonMaximumAspectRatio() const;
 
    // 此函数会遍历SARibbonPanel下的所有RibbonToolButton，执行函数指针(bool(SARibbonRibbonToolButton*))，函数指针返回false则停止迭代
    bool iterateButton(FpRibbonToolButtonIterate fp) const;
 
public:
    virtual QSize sizeHint() const Q_DECL_OVERRIDE;
    virtual QSize minimumSizeHint() const Q_DECL_OVERRIDE;
 
public:
    // panel高度推荐
    static int panelHeightHint(const QFontMetrics& fm, PanelLayoutMode layMode, int panelTitleHeight);
    // 把action的行属性设置进action中，action自身携带了行属性
    static void setActionRowProportionProperty(QAction* action, SARibbonPanelItem::RowProportion rp);
    // 获取action的行属性
    static SARibbonPanelItem::RowProportion getActionRowProportionProperty(QAction* action);
    // 把action的PopupMode属性设置进action中，action自身携带了PopupMode属性
    static void setActionToolButtonPopupModeProperty(QAction* action, QToolButton::ToolButtonPopupMode popMode);
    // 获取action的PopupMode属性
    static QToolButton::ToolButtonPopupMode getActionToolButtonPopupModeProperty(QAction* action);
    // 把action的ToolButtonStyle属性设置进action中，action自身携带了ToolButtonStyle属性
    static void setActionToolButtonStyleProperty(QAction* action, Qt::ToolButtonStyle buttonStyle);
    // 获取action的ToolButtonStyle属性
    static Qt::ToolButtonStyle getActionToolButtonStyleProperty(QAction* action);
 
Q_SIGNALS:
 
    void actionTriggered(QAction* action);
 
    void panelNameChanged(const QString& n);
 
protected:
    virtual void actionEvent(QActionEvent* e) Q_DECL_OVERRIDE;
    virtual void changeEvent(QEvent* e) Q_DECL_OVERRIDE;
 
protected:
    // 以下这些方法是为了接收SARibbonBar的对应接口的参数，用户在操作SARibbonPanel的时候不需要进行设置
    // SARibbonPanel在被设置到SARibbonCategory的时候，SARibbonCategory会重新把自身的这些参数同步到panel中
    // 同理，SARibbonCategory加入SARibbonBar的时候，SARibbonBar会重新把自身的这些参数同步到category
 
    // 设置标题栏高度
    void setTitleHeight(int h);
 
    // 设置按钮之间的间隔
    void setSpacing(int n);
 
    // 是否显示标题，显示标题后，标题的高度需要设置，默认高度为15
    void setEnableShowTitle(bool on);
 
    // 设置按钮允许换行，注意图标大小是由文字决定的，两行文字会让图标变小，如果想图标变大，文字不换行是最好的
    void setEnableWordWrap(bool on);
 
    // 按钮的最大宽高比，这个系数决定按钮的最大宽度
    void setButtonMaximumAspectRatio(qreal fac = 1.4);
};
 
#endif  // SARIBBONPANEL_H