ADTF: qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >

Implementation template which implements a filter that derives from. More...

Inheritance diagram for qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >:

Public Member Functions
	qt_ui_filter ()
	default CTOR This will register the common property "title" to the filters IConfiguration

	~qt_ui_filter ()=default
	DTOR.

tResult	Init (typename FILTERBASECLASS::tInitStage eStage) override
	Override init method of the filter. More...

tResult	Shutdown (typename FILTERBASECLASS::tInitStage eStage) override
	Override shutdon method of the filter. More...

QString	GetStateIdentifier () const
	Get the State Identifier for the Window State callbacks "OnLoadState" and "OnSaveState". More...

QString	GetHelpLink () const
	Returns a filesystem help link to the windows documentation page. More...

Public Member Functions inherited from cQtWindow
QString	GetStateIdentifier () const override
	Returns The user defined window state identifier. More...

void	OnLoadState ([[maybe_unused]] const QString &strStateFolder) override
	Callback function to load the internal window state from the given folder `strStateFolder`. More...

void	OnSaveState ([[maybe_unused]] const QString &strStateFolder) const override
	Callback function to save the internal window state to the given folder `strStateFolder`. More...

QString	GetHelpLink () const override
	Returns a filesystem help link to the windows documentation page. More...

Public Member Functions inherited from IQtXSystem::IWindowState
virtual void	OnLoadState (const QString &strStateFolder)=0
	Callback function to load the internal window state from the given folder `strStateFolder`. More...

virtual void	OnSaveState (const QString &strStateFolder) const =0
	Callback function to save the internal window state to the given folder `strStateFolder`. More...

Private Attributes
adtf::ucom::object_ptr< adtf::ui::spider::IQtXSystem >	m_pXSystem
	The XSystem reference.

Additional Inherited Members
Protected Member Functions inherited from cQtWindow
void	EnableWindowState ()
	Enables the Window state callbacks. More...

bool	IsWindowStateEnabled () const

Protected Member Functions inherited from cQtWindow
	cQtWindow ()=default
	default CTOR

virtual	~cQtWindow ()=default
	default DTOR

virtual QWidget *	CreateView ()=0
	Callback you have to implement and return a newly QWidget which will be embed to the `oParentWidget` of the `Create`. More...

virtual void	ReleaseView ()=0
	Callback you have to implement to cleanup while destroying of the parents window. More...

tResult	Create (const char *strWindowID, QWidget &oParentWidget) override
	Callback which in called within the applications main th thread to create a window. More...

tResult	Destroy (QWidget &) override
	Callback which in called within the applications main th thread to deliver a destroy message to the windows implementation. More...

tResult	OnIdle () override
	Callback for actions within a idle thread. More...

tResult	OnTimer () override
	Callback for actions within a steady timer. More...

Protected Member Functions inherited from IQtXSystem::IWindowState
	~IWindowState ()=default
	protected DTOR

Protected Member Functions inherited from IQtXSystem::IHelp
	~IHelp ()=default
	protected DTOR

Protected Attributes inherited from cQtWindow
adtf::base::property_variable< adtf::util::cString >	m_strTitle
	title property variable will be set while window creating

Detailed Description

template<typename FILTERBASECLASS, typename QTWINDOWBASECLASS = spider::cQtWindow>
class adtf::ui::spider::qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >

Implementation template which implements a filter that derives from.

FILTERBASECLASS type
QTWINDOWBASECLASS type

The FILTERBASECLASS type must fulfill following concept requirements:

implements a cFilter

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 IQtXSystem::IWindowState interface
may implements IHelp interface

Template Parameters

FILTERBASECLASS	A IFilter 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.

Definition at line 256 of file qt_ui_filter.h.

Member Function Documentation

◆ GetHelpLink()

QString 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

Implements IQtXSystem::IHelp.

Definition at line 324 of file qt_ui_filter.h.

References adtf::streaming::spider::get_help_link().

◆ GetStateIdentifier()

QString 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_filter will return the set adtf::streaming::get_named_graph_object_full_name

See also: adtf::ui::riddler::IQtXSystem::IWindowState

Implements IQtXSystem::IWindowState.

Definition at line 315 of file qt_ui_filter.h.

References adtf::streaming::ant::get_named_graph_object_full_name().

◆ Init()

tResult Init ( typename FILTERBASECLASS::tInitStage eStage )

inlineoverride

Override init method of the filter.

The FILTERBASECLASS init method will be called. The window is created while adtf::filter::ant::cFilter::tInitStage::StagePostConnect.

Parameters

[in] eStage current init stage

Returns: Standard Return Code. Returning an error will result in breaking intializing of filtergraph.

Remarks: Use EnableWindowState within your filters CTOR to activate window state callbacks

See also: adtf::ui::riddler::IQtXSystem::IWindowState

Definition at line 276 of file qt_ui_filter.h.

References _runtime, adtf::streaming::ant::get_named_graph_object_full_name(), IRuntime::GetObject(), qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >::m_pXSystem, RETURN_IF_FAILED, and RETURN_NOERROR.

◆ Shutdown()

tResult Shutdown ( typename FILTERBASECLASS::tInitStage eStage )

inlineoverride

Override shutdon method of the filter.

The filters shutdown method will be called. The window is destroyed while adtf::filter::ant::cFilter::tInitStage::StagePostConnect.

Parameters

[in] eStage current shutdown stage

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

Definition at line 296 of file qt_ui_filter.h.

References qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >::m_pXSystem.

Public Member Functions

Private Attributes

Additional Inherited Members