qt_ui_filter.h

Go to the documentation of this file.

 
/*
 * This file depends on Qt which is licensed under LGPLv3.
 * See ADTF_DIR/3rdparty/qt5 and doc/license for detailed information.
 */
#pragma once
#include "qtxsystem_intf.h"
#include "xsystem_qtwindow.h"
 
#include <adtf_utils.h>
#include <adtfucom3/adtf_ucom3.h>
#include <adtfstreaming3/graph_element_editors.h>
#include <adtffiltersdk/filter.h>
#include <adtffiltersdk/dynamic_filter.h>
 
namespace adtf
{
namespace ui
{
namespace ant
{
template<typename FILTERBASECLASS>
class qt_ui_filter : public FILTERBASECLASS, public cQtWindow
{
    adtf::ucom::object_ptr<adtf::ui::ant::IQtXSystem> m_pXSystem;
 
public:
    qt_ui_filter()
    {
        m_strTitle.SetDescription("Window title which will be used at runtime within Qt5 ADTF XSystem UI Service.");
        FILTERBASECLASS::RegisterPropertyVariable("title", m_strTitle);
    }

    ~qt_ui_filter() = default;

    tResult Init(typename FILTERBASECLASS::tInitStage eStage) override
    {
        RETURN_IF_FAILED(FILTERBASECLASS::Init(eStage));
        if (eStage == FILTERBASECLASS::tInitStage::StagePostConnect)
        {
            RETURN_IF_FAILED(_runtime->GetObject(m_pXSystem));
            adtf::util::cString strTitle = m_strTitle;
            if (strTitle.IsEmpty())
            {
                m_strTitle = ::adtf::streaming::get_named_graph_object_full_name(*this);
            }
            RETURN_IF_FAILED(m_pXSystem->CreateWindow(*this));
        }
        RETURN_NOERROR;
    }

    tResult Shutdown(typename FILTERBASECLASS::tInitStage eStage) override
    {
        if (eStage == FILTERBASECLASS::tInitStage::StagePostConnect)
        {
            if (m_pXSystem)
            {
                m_pXSystem->DestroyWindow(*this);
            }
        }
        return (FILTERBASECLASS::Shutdown(eStage));
    }
};

using cQtUIDynamicFilter = qt_ui_filter<adtf::filter::cDynamicFilter>;
using cQtUIFilter = qt_ui_filter<adtf::filter::cFilter>;
} // namespace ant
 
namespace flash
{

using cQtUIFilter = ant::qt_ui_filter<adtf::filter::cFilter>;
using cQtUIDynamicFilter = cQtUIFilter;
} // namespace flash
 
namespace riddler
{

template<typename FILTERBASECLASS>
class qt_ui_filter : public FILTERBASECLASS, public ant::cQtWindow, public IQtXSystem::IWindowState
{
public:
    qt_ui_filter()
    {
        m_strTitle.SetDescription("Window title which will be used at runtime within Qt5 ADTF XSystem UI Service.");
        FILTERBASECLASS::RegisterPropertyVariable("title", m_strTitle);
    }

    ~qt_ui_filter() = default;

    tResult Init(typename FILTERBASECLASS::tInitStage eStage) override
    {
        RETURN_IF_FAILED(FILTERBASECLASS::Init(eStage));
        if (eStage == FILTERBASECLASS::tInitStage::StagePostConnect)
        {
            RETURN_IF_FAILED(_runtime->GetObject(m_pXSystem));
            adtf::util::cString strTitle = m_strTitle;
            if (strTitle.IsEmpty())
            {
                m_strTitle = ::adtf::streaming::get_named_graph_object_full_name(*this);
            }
            const uint32_t ui32Flags = m_bWindowStateEnabled ? IQtXSystem::eWindowCreationFlags::WCF_HasWindowState :
                                                               IQtXSystem::eWindowCreationFlags::WCF_None;
            RETURN_IF_FAILED(m_pXSystem->CreateWindow(*this, ui32Flags));
        }
        RETURN_NOERROR;
    }

    tResult Shutdown(typename FILTERBASECLASS::tInitStage eStage) override
    {
        if (eStage == FILTERBASECLASS::tInitStage::StagePostConnect)
        {
            if (m_pXSystem)
            {
                m_pXSystem->DestroyWindow(*this);
            }
        }
        return (FILTERBASECLASS::Shutdown(eStage));
    }

    QString GetStateIdentifier() const override
    {
        return ::adtf::streaming::get_named_graph_object_full_name(*this, "/").GetPtr();
    }

    void OnLoadState([[maybe_unused]] const QString& strStateFolder) override
    {
    }

    void OnSaveState([[maybe_unused]] const QString& strStateFolder) const override
    {
    }
 
protected:
    void EnableWindowState()
    {
        m_bWindowStateEnabled = true;
    }
 
private:
    adtf::ucom::object_ptr<adtf::ui::riddler::IQtXSystem> m_pXSystem;
    bool m_bWindowStateEnabled = false;
};

using cQtUIFilter = riddler::qt_ui_filter<adtf::filter::cFilter>;
using cQtUIDynamicFilter = cQtUIFilter;
 
} // namespace riddler
 
namespace spider
{

template<typename FILTERBASECLASS, typename QTWINDOWBASECLASS = spider::cQtWindow>
class qt_ui_filter : public FILTERBASECLASS, public QTWINDOWBASECLASS
{
public:
    qt_ui_filter()
    {
        QTWINDOWBASECLASS::m_strTitle.SetDescription(
            "Window title which will be used at runtime within Qt5 ADTF XSystem UI Service.");
        FILTERBASECLASS::RegisterPropertyVariable("title", QTWINDOWBASECLASS::m_strTitle);
    }

    ~qt_ui_filter() = default;

    tResult Init(typename FILTERBASECLASS::tInitStage eStage) override
    {
        RETURN_IF_FAILED(FILTERBASECLASS::Init(eStage));
        if (eStage == FILTERBASECLASS::tInitStage::StagePostConnect)
        {
            RETURN_IF_FAILED(_runtime->GetObject(m_pXSystem));
            if ((*QTWINDOWBASECLASS::m_strTitle).IsEmpty())
            {
                QTWINDOWBASECLASS::m_strTitle = ::adtf::streaming::get_named_graph_object_full_name(*this);
            }
            uint32_t ui32CreationFlags = 0;
            if constexpr (std::is_base_of_v<adtf::ui::v0::cQtWindow, QTWINDOWBASECLASS>)
            {
                ui32CreationFlags = QTWINDOWBASECLASS::IsWindowStateEnabled() ?
                                        IQtXSystem::eWindowCreationFlags::WCF_HasWindowState :
                                        IQtXSystem::eWindowCreationFlags::WCF_None;
            }
            else
            {
                ui32CreationFlags = QTWINDOWBASECLASS::GetWindowCreationFlags();
            }
            RETURN_IF_FAILED(m_pXSystem->CreateWindow(*this, ui32CreationFlags));
        }
        RETURN_NOERROR;
    }

    tResult Shutdown(typename FILTERBASECLASS::tInitStage eStage) override
    {
        if (eStage == FILTERBASECLASS::tInitStage::StagePostConnect)
        {
            if (m_pXSystem)
            {
                m_pXSystem->DestroyWindow(*this);
            }
        }
        return (FILTERBASECLASS::Shutdown(eStage));
    }

    QString GetStateIdentifier() const
    {
        return ::adtf::streaming::get_named_graph_object_full_name(*this, "/").GetPtr();
    }

    QString GetHelpLink() const
    {
        return adtf::streaming::spider::get_help_link((base::ant::IConfiguration&) *this).c_str();
    }
 
private:
    adtf::ucom::object_ptr<adtf::ui::spider::IQtXSystem> m_pXSystem;
};

using cQtUIFilter = qt_ui_filter<adtf::filter::cFilter, cQtWindow>;

using cQtUIDynamicFilter = cQtUIFilter;
 
} // namespace spider
 
namespace v0
{

using spider::cQtUIDynamicFilter;
using spider::cQtUIFilter;
using spider::qt_ui_filter;
 
} // namespace v0
 
namespace v1
{

using cQtUIFilter = v0::qt_ui_filter<adtf::filter::cFilter, cQtWindow>;
using cQtUIDynamicFilter = cQtUIFilter;
 
} // namespace v0
 
using v1::cQtUIDynamicFilter;
using v1::cQtUIFilter;
using v0::qt_ui_filter;
 
} // namespace ui
} // namespace adtf