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,
 
        SingleRowMode
    };
    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;
 
    void addAction(QAction* action, SARibbonPanelItem::RowProportion rowProportion);
    void addAction(QAction* act,
                   QToolButton::ToolButtonPopupMode popMode,
                   SARibbonPanelItem::RowProportion rowProportion = SARibbonPanelItem::Large);
    void addLargeAction(QAction* action);
    void addMediumAction(QAction* action);
    void addSmallAction(QAction* action);
 
    void addSmallAction(QAction* action, QToolButton::ToolButtonPopupMode popMode);
    void addLargeAction(QAction* action, QToolButton::ToolButtonPopupMode popMode);
    void addMediumAction(QAction* action, QToolButton::ToolButtonPopupMode popMode);
    QAction* addAction(const QString& text,
                       const QIcon& icon,
                       QToolButton::ToolButtonPopupMode popMode,
                       SARibbonPanelItem::RowProportion rowProportion = SARibbonPanelItem::Large);
 
    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);
 
    QAction* addSmallWidget(QWidget* w);
 
    QAction* addMediumWidget(QWidget* w);
 
    QAction* addLargeWidget(QWidget* w);
 
    SARibbonGallery* addGallery(bool expanding = true);
 
    QAction* addSeparator();
 
    SARibbonToolButton* actionToRibbonToolButton(QAction* action);
 
    void setOptionAction(QAction* action);
 
    bool isHaveOptionAction() const;
 
    QList< SARibbonToolButton* > ribbonToolButtons() const;
 
    PanelLayoutMode panelLayoutMode() const;
    void setPanelLayoutMode(PanelLayoutMode mode);
 
    void resetToolButtonSize();
 
    bool isTwoRow() const;
 
    void setExpanding(bool isExpanding = true);
    bool isExpanding() const;
 
    int titleHeight() const;
 
    bool isEnableShowTitle() const;
 
    int actionIndex(QAction* act) const;
 
    void moveAction(int from, int to);
 
    bool isCanCustomize() const;
    void setCanCustomize(bool b);
 
    QString panelName() const;
    void setPanelName(const QString& title);
 
    int largeButtonHeight() const;
 
    const QList< SARibbonPanelItem* >& ribbonPanelItem() const;
 
    SARibbonPanelLayout* panelLayout() const;
 
    void updateItemGeometry();
 
    SARibbonCategory* category() const;
 
    SARibbonBar* ribbonBar() const;
 
    int spacing() const;
 
    void setToolButtonIconSize(const QSize& smallSize, const QSize& largeSize);
    QPair< QSize, QSize > toolButtonIconSize() const;
 
    void setLargeIconSize(const QSize& largeSize);
    QSize largeIconSize() const;
 
    void setSmallIconSize(const QSize& smallSize);
    QSize smallIconSize() const;
 
    SARibbonToolButton* lastAddActionButton();
 
    SARibbonPanelLabel* titleLabel() const;
 
    bool isEnableWordWrap() const;
 
    void setEnableIconRightText(bool on);
    bool isEnableIconRightText() const;
 
    qreal buttonMaximumAspectRatio() const;
 
    bool iterateButton(FpRibbonToolButtonIterate fp) const;
 
public:
    virtual QSize sizeHint() const Q_DECL_OVERRIDE;
    virtual QSize minimumSizeHint() const Q_DECL_OVERRIDE;
 
public:
    static int panelHeightHint(const QFontMetrics& fm, PanelLayoutMode layMode, int panelTitleHeight);
    static void setActionRowProportionProperty(QAction* action, SARibbonPanelItem::RowProportion rp);
    static SARibbonPanelItem::RowProportion getActionRowProportionProperty(QAction* action);
    static void setActionToolButtonPopupModeProperty(QAction* action, QToolButton::ToolButtonPopupMode popMode);
    static QToolButton::ToolButtonPopupMode getActionToolButtonPopupModeProperty(QAction* action);
    static void setActionToolButtonStyleProperty(QAction* action, Qt::ToolButtonStyle buttonStyle);
    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:
    // The following methods are for receiving parameters from the corresponding interfaces of SARibbonBar, users do not
    // need to set them when operating SARibbonPanel When SARibbonPanel is set to SARibbonCategory, SARibbonCategory
    // will resynchronize its own parameters to the panel Similarly, when SARibbonCategory is added to SARibbonBar,
    // SARibbonBar will resynchronize its own parameters to the category
 
    void setTitleHeight(int h);
 
    void setSpacing(int n);
 
    void setEnableShowTitle(bool on);
 
    void setEnableWordWrap(bool on);
 
    void setButtonMaximumAspectRatio(qreal fac = 1.4);
};
 
#endif  // SARIBBONPANEL_H