qt_ui_service.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 <adtfsystemsdk/adtf_service.h>
 
namespace adtf
{
namespace ui
{
namespace ant
{
template<typename SERVICEBASECLASS>
class qt_ui_service : public SERVICEBASECLASS, public cQtWindow
{
    adtf::ucom::object_ptr<adtf::ui::ant::IQtXSystem> m_pXSystem;
 
public:
    qt_ui_service()
    {
        m_strTitle.SetDescription("Window title which will be used at runtime within Qt5 ADTF XSystem UI Service.");
        SERVICEBASECLASS::RegisterPropertyVariable("title", m_strTitle);
    }

    ~qt_ui_service() = default;
    tResult ServiceInit() override
    {
        RETURN_IF_FAILED(_runtime->GetObject(m_pXSystem));
        adtf::util::cString strTitle = m_strTitle;
        if (strTitle.IsEmpty())
        {
            strTitle = SERVICEBASECLASS::GetOID();
            m_strTitle = strTitle;
        }
        return m_pXSystem->CreateWindow(*this);
    }

    tResult ServiceShutdown() override
    {
        RETURN_IF_POINTER_NULL(m_pXSystem);
        return m_pXSystem->DestroyWindow(*this);
    }
};

using cQtUIService = qt_ui_service<adtf::system::ant::cADTFService>;
} // namespace ant
 
namespace riddler
{

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

    ~qt_ui_service() override = default;

    tResult ServiceInit() override
    {
        RETURN_IF_FAILED(_runtime->GetObject(m_pXSystem));
        if ((*m_strTitle).IsEmpty())
        {
            m_strTitle = SERVICEBASECLASS::GetOID();
        }
 
        const uint32_t ui32Flags = m_bWindowStateEnabled ? IQtXSystem::eWindowCreationFlags::WCF_HasWindowState :
                                                           IQtXSystem::eWindowCreationFlags::WCF_None;
        // create without layouter reference
        return m_pXSystem->CreateWindow(*this, ui32Flags);
    }

    tResult ServiceShutdown() override
    {
        RETURN_IF_POINTER_NULL(m_pXSystem);
        return m_pXSystem->DestroyWindow(*this);
    }

    QString GetStateIdentifier() const override
    {
        return SERVICEBASECLASS::GetOID();
    }

    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;
};
 
} // namespace riddler
 
namespace spider
{

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

    ~qt_ui_service() override = default;

    tResult ServiceInit() override
    {
        RETURN_IF_FAILED(_runtime->GetObject(m_pXSystem));
        if ((*QTWINDOWBASECLASS::m_strTitle).IsEmpty())
        {
            QTWINDOWBASECLASS::m_strTitle = SERVICEBASECLASS::GetOID();
        }
        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();
        }
        // create without layouter reference
        return m_pXSystem->CreateWindow(*this, ui32CreationFlags);
    }

    tResult ServiceShutdown() override
    {
        RETURN_IF_POINTER_NULL(m_pXSystem);
        return m_pXSystem->DestroyWindow(*this);
    }

    QString GetStateIdentifier() const
    {
        return SERVICEBASECLASS::GetOID();
    }

    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 cQtUIService = qt_ui_service<adtf::system::ant::cADTFService, spider::cQtWindow>;
 
} // namespace spider
 
namespace v0
{
 
using spider::cQtUIService;
using spider::qt_ui_service;
 
} // namespace v0
 
namespace v1
{

using cQtUIService = v0::qt_ui_service<adtf::system::ant::cADTFService, v1::cQtWindow>;
 
} // namespace v0
 
using v1::cQtUIService;
using v0::qt_ui_service;
 
} // namespace ui
} // namespace adtf