adtf::ui::v0::qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS > Class Template Reference

#include <qt_ui_service.h>

Inherits SERVICEBASECLASS, and adtf::ui::spider::cQtWindow.

Public Member Functions
	qt_ui_service ()
	~qt_ui_service () override=default
	DTOR.
tResult	ServiceInit () override
tResult	ServiceShutdown () override
QString	GetStateIdentifier () const
	Get the State Identifier for the Window State callbacks "OnLoadState" and "OnSaveState".
QString	GetHelpLink () const
Public Member Functions inherited from adtf::ui::spider::cQtWindow
void	OnLoadState (const QString &strStateFolder) override
void	OnSaveState (const QString &strStateFolder) const override

Additional Inherited Members
Protected Member Functions inherited from adtf::ui::spider::cQtWindow
void	EnableWindowState ()
	Enables the Window state callbacks. We recommend to use this only within your filters CTOR.
bool	IsWindowStateEnabled () const
Protected Member Functions inherited from adtf::ui::ant::cQtWindow
	cQtWindow ()=default
	default CTOR
virtual	~cQtWindow ()=default
	default DTOR
virtual QWidget *	CreateView ()=0
virtual void	ReleaseView ()=0
tResult	Create (const char *strWindowID, QWidget &oParentWidget) override
	Callback which in called within the applications main th thread to create a window.
tResult	Destroy (QWidget &) override
	Callback which in called within the applications main th thread to deliver a destroy message to the windows implementation.
tResult	OnIdle () override
tResult	OnTimer () override
Protected Member Functions inherited from adtf::ui::riddler::IQtXSystem::IWindowState
	~IWindowState ()=default
	protected DTOR
Protected Member Functions inherited from adtf::ui::spider::IQtXSystem::IHelp
	~IHelp ()=default
	protected DTOR
Protected Attributes inherited from adtf::ui::ant::cQtWindow
adtf::base::property_variable< adtf::util::cString >	m_strTitle
	title property variable will be set while window creating

Detailed Description

template<typename SERVICEBASECLASS, typename QTWINDOWBASECLASS = spider::cQtWindow>
class adtf::ui::v0::qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS >

Implementation template which implements a service that derives from

• SERVICEBASECLASS type
• QTWINDOWBASECLASS type

The SERVICEBASECLASS type must fulfill following concept requirements:

• implements a adtf::system::ant::cADTFService

The QTWINDOWBASECLASS type must fulfill following concept requirements:

• must implement a IQtXSystem::IWindow interface (i.e. adtf::ui::spider::cQtWindow "cQtWindow")
• must declare an accessable m_strTitle; property_variable as member.
• must implement an accessable bool IsWindowStateEnabled() const; method.
• may implement IQtXSystem::IWindowState interface
• may implement IHelp interface

Template Parameters

SERVICEBASECLASS	A adtf::system::ant::cADTFService implementation The Init and Shutdown method will be override.
QTWINDOWBASECLASS	A IQtXSystem::IWindow implementation implementation. By default the adtf::ui::spider::cQtWindow type is used.

Constructor & Destructor Documentation

qt_ui_service()

template<typename SERVICEBASECLASS, typename QTWINDOWBASECLASS = spider::cQtWindow>

adtf::ui::spider::qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS >::qt_ui_service ( )

inline

default CTOR This will register the common property "title" to the services IConfiguration

Member Function Documentation

GetHelpLink()

template<typename SERVICEBASECLASS, typename QTWINDOWBASECLASS = spider::cQtWindow>

QString adtf::ui::spider::qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS >::GetHelpLink ( ) const

inlinevirtual

Returns a filesystem help link to the windows documentation page.

Return values

empty	The link will be ignored.
not-empty	The filesystem help link to the windows documentation page.

Returns

It will return the property entry set by adtf::streaming::hollow::set_help_link

Reimplemented from adtf::ui::spider::cQtWindow.

GetStateIdentifier()

template<typename SERVICEBASECLASS, typename QTWINDOWBASECLASS = spider::cQtWindow>

QString adtf::ui::spider::qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS >::GetStateIdentifier ( ) const

inlinevirtual

Get the State Identifier for the Window State callbacks "OnLoadState" and "OnSaveState".

Returns

QString The unique identifier for the Window state call.

Remarks

qt_ui_service will return the set cADTFService::GetOID() (object identifier)

See also

adtf::ui::riddler::IQtXSystem::IWindowState

Reimplemented from adtf::ui::spider::cQtWindow.

ServiceInit()

template<typename SERVICEBASECLASS, typename QTWINDOWBASECLASS = spider::cQtWindow>

tResult adtf::ui::spider::qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS >::ServiceInit ( )

inlineoverride

Override ServiceInit method of the service to create a window.

Returns

Standard Return Code. Returning an error will result in breaking intializing of system.

Remarks

Use EnableWindowState within the services CTOR to activate window state callbacks

See also

adtf::ui::riddler::IQtXSystem::IWindowState

ServiceShutdown()

template<typename SERVICEBASECLASS, typename QTWINDOWBASECLASS = spider::cQtWindow>

tResult adtf::ui::spider::qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS >::ServiceShutdown ( )

inlineoverride

Override ServiceShutdown method of the service to destroy a window.

Returns

Standard Return Code. Error code will only be logged. Breaking shutdown is not possible.

---

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

• src/libraries/adtfui/include/adtfui/qt_ui_service.h