ADTF: qt_ui_filter< FILTERBASECLASS >

Implementation template which implements a IQtXSystem::IWindow and a IQtXSystem::IWindowState interface and creates a window on the adtf::ui::riddler::IQtXSystem while initializing. More...

Inheritance diagram for qt_ui_filter< FILTERBASECLASS >:

[legend]

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 override
	Get the State Identifier for the Window State callbacks "OnLoadState" and "OnSaveState". 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...

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...

Protected Member Functions
void	EnableWindowState ()
	Enables the Window state callbacks. More...

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

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

bool	m_bWindowStateEnabled = false
	State for enabled window state.

Additional Inherited Members
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>
class adtf::ui::riddler::qt_ui_filter< FILTERBASECLASS >

Implementation template which implements a IQtXSystem::IWindow and a IQtXSystem::IWindowState interface and creates a window on the adtf::ui::riddler::IQtXSystem while initializing.

Template Parameters

FILTERBASECLASS a adtf::filter::hollow::cFilter implementation. The Init and Shutdown method will be override.

Definition at line 124 of file qt_ui_filter.h.

Member Function Documentation

◆ EnableWindowState()

void EnableWindowState ( )

inlineprotected

Enables the Window state callbacks.

We recommend to use this only within your filters CTOR.

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

Definition at line 210 of file qt_ui_filter.h.

References qt_ui_filter< FILTERBASECLASS >::m_bWindowStateEnabled.

◆ GetStateIdentifier()

QString GetStateIdentifier ( ) const

inlineoverridevirtual

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 183 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 144 of file qt_ui_filter.h.

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

◆ OnLoadState()

void OnLoadState ( [[maybe_unused] ] const QString & strStateFolder )

inlineoverride

Callback function to load the internal window state from the given folder strStateFolder.

We recommend to use QSettings to save and load a window state file.

void cMyFilter::OnLoadState(const QString& strStateFolder)
{
    QSettings oSettings(strStateFolder + "/my_window_state.settings", QSettings::IniFormat);
    oSettings.beginGroup("my_window");
    // read your state from the settings file as created within OnSaveState
    oSettings.endGroup();
}

Parameters

[in] strStateFolder The folder to save the window state files to.

Remarks: This callback will be only served if EnableWindowState call is made before!

Definition at line 191 of file qt_ui_filter.h.

◆ OnSaveState()

void OnSaveState ( [[maybe_unused] ] const QString & strStateFolder ) const

inlineoverride

Callback function to save the internal window state to the given folder strStateFolder.

We recommend to use QSettings to save and load a window state file.

void cMyFilter::OnSaveState(const QString& strStateFolder) const
{
    QSettings oSettings(strStateFolder + "/my_window_state.settings", QSettings::IniFormat);
    oSettings.beginGroup("my_window");
    // save your window state to the settings file.
    oSettings.endGroup();
}

Parameters

[in] strStateFolder The folder to save the window state files to.

Remarks: This callback will be only served if EnableWindowState call is made before!

Definition at line 199 of file qt_ui_filter.h.

◆ 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 164 of file qt_ui_filter.h.

References qt_ui_filter< FILTERBASECLASS >::m_pXSystem.

Public Member Functions

Protected Member Functions

Private Attributes

Additional Inherited Members

Detailed Description

template<typename FILTERBASECLASS> class adtf::ui::riddler::qt_ui_filter< FILTERBASECLASS >

Member Function Documentation

◆ EnableWindowState()

◆ GetStateIdentifier()

◆ Init()

◆ OnLoadState()

◆ OnSaveState()

◆ Shutdown()

template<typename FILTERBASECLASS>
class adtf::ui::riddler::qt_ui_filter< FILTERBASECLASS >