CMultiPageWidget.h

Go to the documentation of this file.

/********************************************************************************
**  This file is part of the ICF Framework. Copyright (C) Witold Gantzke & Kirill Lepskiy
**  ICF Framework may be used under the terms of the LGPL License v. 2.1 by the Free Software Foundation.
********************************************************************************/
 
#ifndef iwidgets_CMultiPageWidget_included
#define iwidgets_CMultiPageWidget_included
 
 
// Qt includes
#include <QtCore/QSize>
#include <QtCore/QMap>
#include <QtCore/QtGlobal>
#include <QtGui/QIcon>
#include <QtWidgets/QWidget>
 
// ICF includes
#include <iwidgets/IMultiPageWidgetDelegate.h>
 
 
namespace iwidgets
{
 
 
class CMultiPageWidget: public QWidget
{
    Q_OBJECT
public:
    typedef QWidget BaseClass;
    typedef IMultiPageWidgetDelegate::PageHeaderPosition PageHeaderPosition; 
 
    enum DesignType
    {
        DT_SIMPLE,
 
        DT_TOOL_BOX,
 
        DT_TAB_WIDGET,
 
        DT_SPLITTER,
 
        DT_STACK,
 
        DT_COLLAPSIBLE_GROUPS,
 
        DT_MINI_WIDGETS,
 
        DT_USER = 1024
    };
 
    CMultiPageWidget(
                QWidget* parentWidgetPtr = nullptr,
                int designMode = DT_SIMPLE,
                int containerGuiFlags = IMultiPageWidgetDelegate::CGF_NONE,
                Qt::Orientation orientation = Qt::Vertical);
 
    virtual QWidget* GetContainerWidgetPtr() const;
 
    void SetDesignMode(int designMode);
 
    void SetContainerGuiFlags(int containerGuiFlags);
 
    void SetLayoutOrientation(Qt::Orientation orientation);
 
    virtual void ResetPages();
 
    virtual void SetPageHeaderPosition(PageHeaderPosition pageHeaderPosition);
 
    virtual int InsertPage(
                QWidget* pageWidgetPtr,
                const QString& pageTitle,
                int pageIndex = -1);
 
    virtual void RemovePage(int pageIndex);
 
    virtual int GetPagesCount() const; 
 
    virtual QWidget* GetPageWidgetPtr(int pageIndex) const; 
 
    virtual int GetCurrentPage() const;
 
    virtual bool SetCurrentPage(int pageIndex);
 
    virtual QString GetPageTitle(int pageIndex) const;
 
    virtual void SetPageTitle(int pageIndex, const QString& pageTitle);
 
    virtual QIcon GetPageIcon(int pageIndex) const;
 
    virtual void SetPageIcon(int pageIndex, const QIcon& pageIcon);
 
    virtual QString GetPageToolTip(int pageIndex) const;
 
    virtual void SetPageToolTip(int pageIndex, const QString& pageToolTip);
 
    virtual bool IsPageEnabled(int pageIndex) const;
 
    virtual bool SetPageEnabled(int pageIndex, bool isPageEnabled = true);
 
    virtual bool IsPageVisible(int pageIndex) const;
 
    virtual bool SetPageVisible(int pageIndex, bool isPageVisible = true);
 
    virtual QSize GetPageIconSize() const;
 
    virtual bool SetPageIconSize(const QSize& pageIconSize);
 
    template<class DelegateImpl>
    void RegisterMultiPageWidgetDelegate(int uiMode);
 
    // static methods
    static bool IsPageIndexChangeSupported(int designMode);
 
Q_SIGNALS:
    void EmitPageIndexChanged(int pageIndex);
 
protected Q_SLOTS:
    void OnPageIndexChanged(int pageIndex);
 
private:
    typedef std::shared_ptr<IMultiPageWidgetDelegate> MultiPageWidgetDelegatePtr;
 
    bool CreateContainerGui();
 
    MultiPageWidgetDelegatePtr GetCurrentDelegate() const;
 
private:
    typedef QMap<int, MultiPageWidgetDelegatePtr> ContainerWidgetDelegateMap;
        
    ContainerWidgetDelegateMap m_containerWidgetDelegateMap;
 
    std::unique_ptr<QWidget> m_guiContainerPtr;
 
    int m_designMode;
 
    int m_containerGuiFlags;
 
    Qt::Orientation m_orientation;
 
    QSize m_pageIconSize;
 
    bool m_pageSwitchingBlocked;
};
 
 
template<class DelegateImpl>
void CMultiPageWidget::RegisterMultiPageWidgetDelegate(int uiMode)
{
    MultiPageWidgetDelegatePtr delegatePtr = MultiPageWidgetDelegatePtr(new DelegateImpl);
 
    m_containerWidgetDelegateMap[uiMode] = delegatePtr;
}
 
 
} // namespace iwidgets
 
 
#endif // !iwidgets_CMultiPageWidget_included