adtf::ui::spider::IQtXSystem::IHelp Class Reference

#include <qtxsystem_intf.h>

Inherited by adtf::ui::spider::cQtWindow, and adtf::ui::v1::cQtWindow.

Public Member Functions
virtual QString	GetHelpLink () const =0

Protected Member Functions
	~IHelp ()=default
	protected DTOR

Detailed Description

The window info interface to return a link to the windows documentation page. Usually it should return the recommended property links of the filter or service set by adtf::streaming::hollow::set_help_link to the filters or services properties.

Member Function Documentation

GetHelpLink()

virtual QString adtf::ui::spider::IQtXSystem::IHelp::GetHelpLink ( ) const

pure virtual

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.

Implemented in adtf::ui::cQtWindow, adtf::ui::qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >, adtf::ui::qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS >, adtf::ui::spider::cQtWindow, adtf::ui::spider::qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >, adtf::ui::spider::qt_ui_filter< adtf::filter::cFilter, cQtWindow >, adtf::ui::spider::qt_ui_filter< adtf::filter::cFilter, cQtWindow >, adtf::ui::spider::qt_ui_filter< adtf::filter::cFilter, cQtWindow >, adtf::ui::spider::qt_ui_filter< adtf::filter::cFilter, cQtWindow >, adtf::ui::spider::qt_ui_filter< adtf::filter::cFilter, cQtWindow >, adtf::ui::spider::qt_ui_filter< adtf::filter::cFilter, cQtWindow >, adtf::ui::spider::qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS >, adtf::ui::spider::qt_ui_service< adtf::system::ant::cADTFService, spider::cQtWindow >, adtf::ui::spider::qt_ui_service< adtf::system::ant::cADTFService, spider::cQtWindow >, adtf::ui::spider::qt_ui_service< adtf::system::ant::cADTFService, spider::cQtWindow >, adtf::ui::spider::qt_ui_service< adtf::system::ant::cADTFService, spider::cQtWindow >, adtf::ui::spider::qt_ui_service< adtf::system::ant::cADTFService, spider::cQtWindow >, adtf::ui::spider::qt_ui_service< adtf::system::ant::cADTFService, spider::cQtWindow >, adtf::ui::v0::cQtWindow, adtf::ui::v0::qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >, adtf::ui::v0::qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS >, and adtf::ui::v1::cQtWindow.

---

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

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