Interface definition for the ADTF XSystem based on Qt. Use this interface to create your own displays within the Qt5 ADTF XSystem UI Service. More...

#include <qtxsystem_intf.h>

Inherits adtf::ui::ant::IQtXSystem.

Inherited by adtf::ui::riddler::IQtXSystem.

Public Types
enum	eWindowCreationFlags { WCF_None = 0x00 , WCF_DestroyOnClose = 0x01 , WCF_HasWindowState = 0x02 , WCF_HideOnCloseDestroyOnRemove = 0x04 , WCF_DockWindowStateOnExport = 0x08 }
	Windows creation flags used within CreateWindow. More...

Public Member Functions
	ADTF_IID (IQtXSystem, "qt_xsystem.osborn.services.adtf.iid")
	interface id for adtf::ucom::ant::ucom_cast

virtual tResult	CreateWindow (IWindow &oWindow, uint32_t nFlags)=0
	Create and register a window to the XSystem.

virtual tResult	CreateWindow (IWindow &oWindow)=0
	Create and register a window to the XSystem.

Public Member Functions inherited from adtf::ui::ant::IQtXSystem
	ADTF_IID (IQtXSystem, "qt_xsystem.ant.services.adtf.iid")
	interface id for adtf::ucom::ant::ucom_cast

virtual tResult	DestroyWindow (IWindow &oWindow)=0
	Destroy and unregister a window from the XSystem.

Protected Member Functions
	~IQtXSystem ()=default
	protected DTOR

Protected Member Functions inherited from adtf::ui::ant::IQtXSystem
	~IQtXSystem ()=default
	protected DTOR

Detailed Description

Interface definition for the ADTF XSystem based on Qt. Use this interface to create your own displays within the Qt5 ADTF XSystem UI Service.

Since Qt is NOT binary compatible between Release and Debug versions the QWidget class of Qt is used. See Qt5 ADTF XSystem UI Service how to use it. A Default implementation is provided via Qt5 ADTF XSystem UI Service.

Member Enumeration Documentation

◆ eWindowCreationFlags

enum adtf::ui::osborn::IQtXSystem::eWindowCreationFlags

Windows creation flags used within CreateWindow.

Enumerator
WCF_None	no flag set.
WCF_DestroyOnClose	Destroy window and all child widgets when the window is closed.
WCF_HasWindowState	Enable the window state calls for IQtXSystem::IWindowState.
WCF_HideOnCloseDestroyOnRemove	This will close the window on "X" and "Close" via menu. An additional "Remove" menu entry will destroy the window and remove it from window manager.
WCF_DockWindowStateOnExport	This requests to save and restore the xsystems dock windows state when exporting/importing.

Member Function Documentation

◆ CreateWindow() [1/2]

virtual tResult adtf::ui::ant::IQtXSystem::CreateWindow ( IWindow & oWindow )

virtual

Create and register a window to the XSystem.

CreateWindow is a blocking call for window creation and can be called within any context. Depending on the implementation the IWindow::Create method to pWindow will be called. The implementation has to make sure the window creation is done only within the main message queue thread. Otherwise it may fail.

Parameters

[in] oWindow Window implementation. Consider adtf::ui::v1::cQtWindow.

Returns: Usually this is the return value of the resulting IWindow::Destroy method.

See also: IWindow::Create, adtf::ui::v1::cQtWindow

Implements adtf::ui::ant::IQtXSystem.

◆ CreateWindow() [2/2]

virtual tResult adtf::ui::osborn::IQtXSystem::CreateWindow	(	IWindow &	oWindow,
		uint32_t	nFlags )

pure virtual

Create and register a window to the XSystem.

CreateWindow is a blocking call for window creation and can be called within any context. Depending on the implementation the IWindow::Create method to pWindow will be called. The implementation has to make sure the window creation is done only within the main message queue thread. Otherwise it may fail.

Parameters

[in]	oWindow	Window implementation. Consider adtf::ui::ant::cQtWindow.
[in]	nFlags	Window screation flags,

See also: eWindowCreationFlags.

Returns: Usually this is the return value of the resulting IWindow::Create method.

See also: IWindow::Create, adtf::ui::cQtWindow, adtf::ui::IQtXSystem::IWindowState

The documentation for this class was generated from the following file:

src/libraries/adtfui/include/adtfui/qtxsystem_intf.h

Public Types