ADTF Qt5
Loading...
Searching...
No Matches
adtf::ui::ant::IQtXSystem Class Referenceabstract

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::ucom::ant::IObject.

Inherited by adtf::ui::osborn::IQtXSystem.

Classes

class  IWindow
 

Public Member Functions

 ADTF_IID (IQtXSystem, "qt_xsystem.ant.services.adtf.iid")
 interface id for adtf::ucom::ant::ucom_cast
 
virtual tResult CreateWindow (IWindow &oWindow)=0
 Create and register a window to the XSystem.
 
virtual tResult DestroyWindow (IWindow &oWindow)=0
 Destroy and unregister a window from the XSystem.
 

Protected Member Functions

 ~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 Function Documentation

◆ CreateWindow()

virtual tResult adtf::ui::ant::IQtXSystem::CreateWindow ( IWindow & oWindow)
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]oWindowWindow 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

Implemented in adtf::ui::osborn::IQtXSystem.

◆ DestroyWindow()

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

Destroy and unregister a window from the XSystem.

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

Parameters
[in]oWindowWindow implementation. Consider adtf::ui::cQtWindow, adtf::ui::cQtUIFilter and adtf::ui::cQtUIService.
Returns
Usually this is the return value of the resulting IWindow::Destroy method.
Return values
ERR_NOT_FOUNDThe window is not registered.
See also
IWindow::Destroy, adtf::ui::v1::cQtWindow

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