CGuiComponentBase.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/QString>
#include <QtGui/QIcon>
 
// ACF includes
#include <imod/TModelWrap.h>
#include <icomp/CComponentBase.h>
#include <ibase/TLocalizableWrap.h>
#include <iqtgui/IGuiObject.h>
#include <iqtgui/IVisualStatus.h>
#include <iqtgui/TDesignSchemaHandlerWrap.h>
#include <iqtgui/TMakeIconProviderCompWrap.h>
 
 
namespace iqtgui
{
 
 
class CGuiComponentBase:
                     public QObject,
                     public TMakeIconProviderCompWrap<ibase::TLocalizableWrap<icomp::CComponentBase>>,
                     virtual public IGuiObject
{
public:
       typedef TMakeIconProviderCompWrap<ibase::TLocalizableWrap<icomp::CComponentBase>> BaseClass;
 
       I_BEGIN_BASE_COMPONENT(CGuiComponentBase);
              I_REGISTER_INTERFACE(IGuiObject);
              I_REGISTER_SUBELEMENT(VisualStatus);
              I_REGISTER_SUBELEMENT_INTERFACE_T(VisualStatus, IVisualStatus, ExtractVisualStatus);
              I_REGISTER_SUBELEMENT_INTERFACE_T(VisualStatus, istd::IChangeable, ExtractVisualStatus);
              I_REGISTER_SUBELEMENT_INTERFACE_T(VisualStatus, imod::IModel, ExtractVisualStatus);
              I_ASSIGN(m_defaultStatusIconPathAttrPtr, "DefaultStatusIcon", "Path of status icon used by default", false, "");
              I_ASSIGN(m_defaultStatusTextAttrPtr, "DefaultStatusText", "Status text used by default", true, "");
              I_ASSIGN(m_styleSheetPathAttrPtr, "StyleSheet", "Path to the style sheet file used for this UI component.", false, "");
              I_ASSIGN(m_objectIdAttrPtr, "ObjectId", "ID of the widget", false, "");
              I_ASSIGN(m_fixedWidthAttrPtr, "FixedWidth", "Fixed width of the widget", false, 300);
              I_ASSIGN(m_fixedHeightAttrPtr, "FixedHeight", "Fixed height of the widget", false, 300);
       I_END_COMPONENT;
 
       CGuiComponentBase();
 
       bool IsGuiShown() const;
 
       // reimplemented (iqtgui::IGuiObject)
       virtual bool IsGuiCreated() const override;
       virtual bool CreateGui(QWidget* parentPtr) override;
       virtual bool DestroyGui() override;
       virtual QWidget* GetWidget() const override;
       virtual void OnTryClose(bool* ignoredPtr = NULL) override;
 
#if _MSC_VER < 1500
public:
#else
protected:
#endif
       class VisualStatus: virtual public IVisualStatus
       {
       public:
              // reimplemented (iqtgui::IVisualStatus)
              virtual QIcon GetStatusIcon() const override;
              virtual QString GetStatusText() const override;
 
              friend class CGuiComponentBase;
 
       private:
              QIcon m_statusIcon;
              QString m_statusText;
       };
 
protected:
       virtual void OnGuiDesignChanged();
 
       virtual void OnGuiShown();
 
       virtual void OnGuiHidden();
 
       virtual bool OnKeyPressed(QKeyEvent* event);
 
       virtual void OnRetranslate();
 
       virtual void OnGuiRetranslate();
 
       virtual void OnGuiCreated();
 
       virtual void OnGuiDestroyed();
 
       void SetStatusIcon(const QIcon& icon);
       void SetStatusText(const QString& text);
 
       void SetDefaultVisualStatus();
 
       // reimplemented (ibase::TLocalizableWrap)
       virtual void OnLanguageChanged() override;
 
       // reimplemented (ibase::TDesignSchemaHandlerWrap)
       virtual void OnDesignSchemaChanged(const QByteArray& themeId) override;
 
       // reimplemented (QObject)
       virtual bool eventFilter(QObject* sourcePtr, QEvent* eventPtr) override;
 
       // reimplemented (icomp::CComponentBase)
       virtual void OnComponentCreated() override;
       virtual void OnComponentDestroyed() override;
 
       // abstract methods
       virtual QWidget* CreateQtWidget(QWidget* parentPtr) = 0;
 
       // attributes
       imod::TModelWrap<VisualStatus> m_visualStatus;
 
private:
       void MakeAutoSlotConnection();
 
       I_ATTR(QString, m_defaultStatusIconPathAttrPtr);
       I_TEXTATTR(m_defaultStatusTextAttrPtr);
       I_ATTR(QString, m_styleSheetPathAttrPtr);
       I_ATTR(QByteArray, m_objectIdAttrPtr);
       I_ATTR(int, m_fixedWidthAttrPtr);
       I_ATTR(int, m_fixedHeightAttrPtr);
 
       QWidget* m_widgetPtr;
       bool m_isGuiShown;
 
       QIcon m_defaultStatusIcon;
 
       // static template methods for subelement access
       template <class InterfaceType>
       static InterfaceType* ExtractVisualStatus(CGuiComponentBase& component)
       {
              return &component.m_visualStatus;
       }
 
       bool m_hasPendingDesignChanges;
};
 
 
// inline methods
 
inline bool CGuiComponentBase::IsGuiShown() const
{
       return m_isGuiShown;
}
 
 
// reimplemented (iqtgui::IGuiObject)
 
inline QWidget* CGuiComponentBase::GetWidget() const
{
       return m_widgetPtr;
}
 
 
} // namespace iqtgui