idoc::IHelpInfoProvider Class Reference

Allow to show help document to specified object or text. More...

#include <IHelpInfoProvider.h>

Inheritance diagram for idoc::IHelpInfoProvider:

Collaboration diagram for idoc::IHelpInfoProvider:

Public Member Functions
virtual double	GetHelpQuality (const QString &contextText, const istd::IPolymorphic *contextObjectPtr) const =0
	Get quality of help information for specified context and/or object.

Detailed Description

Allow to show help document to specified object or text.

Definition at line 23 of file IHelpInfoProvider.h.

Member Function Documentation

GetHelpQuality()

virtual double idoc::IHelpInfoProvider::GetHelpQuality ( const QString & contextText, const istd::IPolymorphic * contextObjectPtr ) const

pure virtual

Get quality of help information for specified context and/or object.

Returns

quality of help. It represented as value in range [0, 1]. 0 means there is no usable help, 1 means good context specified help is available.

Implemented in icmpstr::CComponentHelpFileProviderComp, icmpstr::CQuickHelpGuiComp, idocgui::CDoxygenHelpFileProviderComp, idocgui::CHtmlHelpGuiComp, idocgui::CHtmlHelpViewerComp, and idocgui::CStaticHelpFileProviderComp.

---

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

• idoc/IHelpInfoProvider.h