CMultiPageWidget.h

Go to the documentation of this file.

// SPDX-License-Identifier: LGPL-2.1-or-later OR GPL-2.0-or-later OR GPL-3.0-or-later OR LicenseRef-ACF-Commercial
#pragma once
 
 
// Qt includes
#include <QtCore/QSize>
#include <QtCore/QMap>
#include <QtCore/QtGlobal>
#include <QtGui/QIcon>
 
#if QT_VERSION >= 0x050000
#include <QtWidgets/QWidget>
#else
#include <QtGui/QWidget>
#endif
 
// ACF includes
#include <istd/TSmartPtr.h>
#include <istd/TDelPtr.h>
#include <iwidgets/IMultiPageWidgetDelegate.h>
#include <iwidgets/CWidgetWheelEventBlocker.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 = NULL,
                            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 istd::TSmartPtr<IMultiPageWidgetDelegate> MultiPageWidgetDelegatePtr;
 
       bool CreateContainerGui();
 
       MultiPageWidgetDelegatePtr GetCurrentDelegate() const;
 
private:
       typedef QMap<int, MultiPageWidgetDelegatePtr> ContainerWidgetDelegateMap;
              
       ContainerWidgetDelegateMap m_containerWidgetDelegateMap;
 
       istd::TDelPtr<QWidget> m_guiContainerPtr;
 
       int m_designMode;
 
       int m_containerGuiFlags;
 
       Qt::Orientation m_orientation;
 
       QSize m_pageIconSize;
 
       bool m_pageSwitchingBlocked;
       
       istd::TDelPtr<CWidgetWheelEventBlocker> m_widgetWheelEventBlockerPtr;
 
};
 
 
template<class DelegateImpl>
void CMultiPageWidget::RegisterMultiPageWidgetDelegate(int uiMode)
{
       MultiPageWidgetDelegatePtr delegatePtr = MultiPageWidgetDelegatePtr(new DelegateImpl);
 
       m_containerWidgetDelegateMap[uiMode] = delegatePtr;
}
 
 
} // namespace iwidgets