adtf::ui::qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS > Class Template Reference

#include <qt_ui_filter.h>

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

Public Member Functions
	qt_ui_filter ()
	~qt_ui_filter ()=default
	DTOR.
tResult	Init (typename FILTERBASECLASS::tInitStage eStage) override
tResult	Shutdown (typename FILTERBASECLASS::tInitStage eStage) 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 FILTERBASECLASS, typename QTWINDOWBASECLASS = spider::cQtWindow>
class adtf::ui::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 adtf::filter::hollow::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 adtf::streaming::ant::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.

Constructor & Destructor Documentation

qt_ui_filter()

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

adtf::ui::spider::qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >::qt_ui_filter ( )

inline

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

Member Function Documentation

GetHelpLink()

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

QString adtf::ui::spider::qt_ui_filter< FILTERBASECLASS, 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 FILTERBASECLASS, typename QTWINDOWBASECLASS = spider::cQtWindow>

QString adtf::ui::spider::qt_ui_filter< FILTERBASECLASS, 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_filter will return the set adtf::streaming::get_named_graph_object_full_name

See also

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

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

Init()

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

tResult adtf::ui::spider::qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >::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

Shutdown()

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

tResult adtf::ui::spider::qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >::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.

---

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

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