adtf::ui::v0::cQtWindow Class Reference

#include <xsystem_qtwindow.h>

Inherits adtf::ui::ant::cQtWindow, adtf::ui::riddler::IQtXSystem::IWindowState, and adtf::ui::spider::IQtXSystem::IHelp.

Inherited by adtf::ui::spider::qt_ui_filter< adtf::filter::cFilter, cQtWindow >, adtf::ui::spider::qt_ui_service< adtf::system::ant::cADTFService, spider::cQtWindow >, adtf::ui::spider::qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >, and adtf::ui::spider::qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS >.

Public Member Functions
QString	GetStateIdentifier () const override
void	OnLoadState (const QString &strStateFolder) override
void	OnSaveState (const QString &strStateFolder) const override
QString	GetHelpLink () const override

Protected Member Functions
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

Additional Inherited Members
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

Basic IWindow implementation. This implementation is used to provide callbacks on creation and destroying widget while IWindow::Create call.

The Create method will call the CreateView first and embed your created widget to the oParentWidget. Additionally it will implement the riddler::IQtXSystem::IWindowState and the spider::IQtXSystem::IHelp interface.

See also

adtf::ui::spider::IQtXSystem, riddler::IQtXSystem::IWindowState, Example Qt5 Video Display

Member Function Documentation

EnableWindowState()

void adtf::ui::spider::cQtWindow::EnableWindowState ( )

inlineprotected

Enables the Window state callbacks. We recommend to use this only within your filters CTOR.

See also

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

GetHelpLink()

QString adtf::ui::spider::cQtWindow::GetHelpLink ( ) const

inlineoverridevirtual

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.

Implements adtf::ui::spider::IQtXSystem::IHelp.

GetStateIdentifier()

QString adtf::ui::spider::cQtWindow::GetStateIdentifier ( ) const

inlineoverridevirtual

Returns The user defined window state identifier.

Returns

The state identifier.

See also

adtf::ui::riddler::qt_ui_filter::GetStateIdentifier, adtf::ui::riddler::qt_ui_service::GetStateIdentifier

Remarks

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

Implements adtf::ui::riddler::IQtXSystem::IWindowState.

IsWindowStateEnabled()

bool adtf::ui::spider::cQtWindow::IsWindowStateEnabled ( ) const

inlineprotected

Return values

true	EnableWindowState was called
false	EnableWindowState was not called

OnLoadState()

void adtf::ui::spider::cQtWindow::OnLoadState ( const QString & strStateFolder )

inlineoverridevirtual

Callback function to load the internal window state from the given folder strStateFolder. We recommend to use QSettings to save and load a UI View Settings file.

void cMyFilter::OnLoadState(const QString& strStateFolder)
{
    const auto strUISettingsFile = strStateFolder + "/my_ui_view.settings";
    if (QFileInfo(strLayoutFile).exists())
    {
        QSettings oSettings(strUISettingsFile, QSettings::IniFormat);
        oSettings.beginGroup("my_window");
        // read your state from the UI View Settings as created within OnSaveState
        oSettings.endGroup();
    }
    else
    {
        if (!is_window_state_folder_on_runlevel_change(strStateFolder))
        {
            THROW_ERROR_DESC(ERR_INVALID_FILE, "UI View Settings file not found: %s",
                             strLayoutFile.toStdString().c_str());
        }
    }
}

Parameters

[in]

strStateFolder

The folder to save the UI View Settings files to.

Remarks

If no UI View Settings file is found you may throw ERR_INVALID_FILE, unless the state folder was recently created, while initializing the very first time on runlevel changes.

throw ERR_CANCEL to indicate the loading was cancelled on purpose.

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

Implements adtf::ui::riddler::IQtXSystem::IWindowState.

OnSaveState()

void adtf::ui::spider::cQtWindow::OnSaveState ( const QString & strStateFolder ) const

inlineoverridevirtual

Callback function to save the internal window state to the given folder strStateFolder. We recommend to use QSettings to save and load a UI View Settings file.

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

Parameters

[in]

strStateFolder

The folder to save the UI View Settings files to.

Remarks

You may throw within a tResult to indicate an error during saving. An ERR_CANCLED indicates the saving was cancelled on purpose.

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

Implements adtf::ui::riddler::IQtXSystem::IWindowState.

---

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

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