CGuiComponentBase.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 iqtgui_CGuiComponentBase_included
#define iqtgui_CGuiComponentBase_included
 
 
// Qt includes
#include <QtCore/QString>
#include <QtGui/QIcon>
 
// ICF includes
#include <istd/CMainThreadCaller.h>
#include <imod/TModelWrap.h>
#include <icomp/CComponentBase.h>
#include <ibase/TVisualChangesHandlerWrap.h>
#include <istdgui/IGuiObject.h>
#include <istdgui/IVisualStatus.h>
 
 
namespace istdgui
{
 
 
class CGuiComponentBase:
        public QObject,
        public ibase::TVisualChangesHandlerWrap<icomp::CComponentBase>,
        virtual public IGuiObject
{
public:
    typedef ibase::TVisualChangesHandlerWrap<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, "WidgetId", "QT 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 (istdgui::IGuiObject)
    bool IsGuiCreated() const override;
    bool CreateGui(QWidget* parentPtr) override;
    bool DestroyGui() override;
    QWidget* GetWidget() const override;
    void OnTryClose(bool* ignoredPtr = nullptr) override;
 
    static void MakeAutoSlotConnection(const QWidget& widget, QObject& object);
 
protected:
    class VisualStatus: virtual public IVisualStatus
    {
    public:
        // reimplemented (istdgui::IVisualStatus)
        QIcon GetStatusIcon() const override;
        QString GetStatusText() const override;
 
        friend class CGuiComponentBase;
 
    private:
        QIcon m_statusIcon;
        QString m_statusText;
    };
 
    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);
 
    // reimplemented (ibase::TVisualChangesHandlerWrap)
    void OnLanguageChanged() override;
    void OnDesignSchemaChanged() override;
 
    // reimplemented (QObject)
    bool eventFilter(QObject* sourcePtr, QEvent* eventPtr) override;
 
    // reimplemented (icomp::CComponentBase)
    void OnComponentCreated() override;
    void OnComponentDestroyed() override;
 
    // abstract methods
    virtual QWidget* CreateQtWidget(QWidget* parentPtr) = 0;
 
    // provides call of GUI functions from any thread
    istd::CMainThreadCaller m_updateGuiCaller;
 
    // attributes
    imod::TModelWrap<VisualStatus> m_visualStatus;
 
private:
    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;
    }
};
 
 
// inline methods
 
inline bool CGuiComponentBase::IsGuiShown() const
{
    return m_isGuiShown;
}
 
 
// reimplemented (istdgui::IGuiObject)
 
inline QWidget* CGuiComponentBase::GetWidget() const
{
    return m_widgetPtr;
}
 
 
} // namespace istdgui
 
 
#endif // !iqtgui_CGuiComponentBase_included