qtxsystem_intf.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 <adtf_utils.h>
#include <adtfucom3/adtf_ucom3.h>
 
#include <qwidget.h>

#define CID_ADTF_XSYSTEM "qt_xsystem.ui_service.adtf.cid"
 
namespace adtf
{
namespace ui
{
namespace ant
{
 
#ifdef CreateWindow
    #undef CreateWindow
#endif

class IQtXSystem : public adtf::ucom::ant::IObject
{
protected:
    ~IQtXSystem() = default;
 
public:
    ADTF_IID(IQtXSystem, "qt_xsystem.ant.services.adtf.iid");

    class IWindow
    {
    protected:
        // protected destruct
        ~IWindow() = default;
 
    public:
        virtual tResult Create(const char* strWindowID, QWidget& oParentWidget) = 0;
        virtual tResult Destroy(QWidget& oParentWidget) = 0;

        virtual tResult OnIdle() = 0;

        virtual tResult OnTimer() = 0;
    };

    virtual tResult CreateWindow(IWindow& oWindow) = 0;

    virtual tResult DestroyWindow(IWindow& oWindow) = 0;
};
} // namespace ant
 
namespace osborn
{

class IQtXSystem : public ant::IQtXSystem
{
protected:
    ~IQtXSystem() = default;
 
public:
    ADTF_IID(IQtXSystem, "qt_xsystem.osborn.services.adtf.iid");

    enum eWindowCreationFlags
    {
        WCF_None = 0x00,
        WCF_DestroyOnClose = 0x01,
        WCF_HasWindowState = 0x02,
        WCF_HideOnCloseDestroyOnRemove = 0x04,
        WCF_DockWindowStateOnExport = 0x08
    };
 
    using ant::IQtXSystem::CreateWindow;

    virtual tResult CreateWindow(IWindow& oWindow, uint32_t nFlags) = 0;
};
 
} // namespace osborn
 
namespace riddler
{

class IQtXSystem : public osborn::IQtXSystem
{
protected:
    ~IQtXSystem() = default;
 
public:
    ADTF_IID(IQtXSystem, "qt_xsystem.riddler.services.adtf.iid");

    class IWindowState
    {
    protected:
        ~IWindowState() = default;
 
    public:
        virtual QString GetStateIdentifier() const = 0;
        virtual void OnLoadState(const QString& strStateFolder) = 0;
        virtual void OnSaveState(const QString& strStateFolder) const = 0;
    };
};

QString get_window_state_folder_name(const QString& strSessionDataDir, const QString& strShortPathName);
 
} // namespace riddler
 
namespace spider
{

class IQtXSystem : public riddler::IQtXSystem
{
protected:
    ~IQtXSystem() = default;
 
public:
    ADTF_IID(IQtXSystem, "qt_xsystem.spider.services.adtf.iid");
    class IHelp
    {
    protected:
        ~IHelp() = default;
 
    public:
        virtual QString GetHelpLink() const = 0;
    };
};
 
} // namespace spider
 
namespace v0
{
 
using spider::IQtXSystem;
using riddler::get_window_state_folder_name;
 
} // namespace v0
 
namespace v1
{

class IQtXSystem : public v0::IQtXSystem
{
protected:
    ~IQtXSystem() = default;
 
public:
    ADTF_IID(IQtXSystem, "qt_xsystem.v1.services.adtf.iid");
    class IWindowState
    {
    protected:
        ~IWindowState() = default;
 
    public:
        enum StateFlags : uint32_t
        {
            Content = 0x01,

            Layout = 0x02,

            Interactive = 0x04
        };

        virtual QString GetStateIdentifier() const = 0;
        virtual void OnLoadState(const QString& strStateFolder, uint32_t ui32LoadStateFlags) = 0;
        virtual void OnSaveState(const QString& strStateFolder, uint32_t ui32SaveStateFlags) const = 0;
    };
};
 
} // namespace v1
 
using v1::IQtXSystem;
using v0::get_window_state_folder_name;
 
} // namespace ui
} // namespace adtf