IQtXSystem::IHelp

The window info interface to return a link to the windows documentation page. More...

Inheritance diagram for IQtXSystem::IHelp:

Public Member Functions
virtual QString	GetHelpLink () const =0
	Returns a filesystem help link to the windows documentation page. More...

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.

See also

spider::qt_ui_filter, spider::qt_ui_service, adtf::streaming::hollow::set_help_link

Definition at line 313 of file qtxsystem_intf.h.

Member Function Documentation

GetHelpLink()

virtual QString 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 cQtWindow, qt_ui_service< SERVICEBASECLASS, QTWINDOWBASECLASS >, and qt_ui_filter< FILTERBASECLASS, QTWINDOWBASECLASS >.