Public Member Functions | List of all members
idoc::IHelpInfoProvider Class Referenceabstract

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

#include <IHelpInfoProvider.h>

Inheritance diagram for idoc::IHelpInfoProvider:
istd::IPolymorphic idoc::IHelpFileProvider idoc::IHelpViewer iqtdoc::CDoxygenHelpFileProviderComp iqtdoc::CStaticHelpFileProviderComp iqtdoc::CHtmlHelpGuiComp iqtdoc::CHtmlHelpViewerComp

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. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Detailed Description

Allow to show help document to specified object or text.

Definition at line 19 of file IHelpInfoProvider.h.

Member Function Documentation

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 iqtdoc::CHtmlHelpViewerComp, iqtdoc::CHtmlHelpGuiComp, iqtdoc::CStaticHelpFileProviderComp, and iqtdoc::CDoxygenHelpFileProviderComp.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy