idoc::IHelpFileProvider Class Reference

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

#include <IHelpFileProvider.h>

Inheritance diagram for idoc::IHelpFileProvider:

Public Member Functions
virtual QString	GetHelpFilePath (const QString &contextText, const istd::IPolymorphic *contextObjectPtr) const =0
	Get access to help file path for specified help information.
Public Member Functions inherited from idoc::IHelpInfoProvider
virtual double	GetHelpQuality (const QString &contextText, const istd::IPolymorphic *contextObjectPtr) const =0
	Get quality of help information for specified context and/or object.
Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Detailed Description

Allow to show help document to specified object or text.

Provides file path resolution for help content. This interface extends IHelpInfoProvider to add the ability to map help contexts to actual file paths.

Help file providers typically:

• Map context strings to HTML files
• Resolve object types to documentation pages
• Handle different help file organizations (Doxygen, static HTML, etc.)

Usage Example

idoc::IHelpFileProvider* helpProvider = GetHelpFileProvider();
 
// Get help file path for a context
QString contextText = "IDocumentManager";
QString helpPath = helpProvider->GetHelpFilePath(contextText, nullptr);
if (!helpPath.isEmpty()) {
       qDebug() << "Help file:" << helpPath;
       // Load and display the help file
}
 
// Get help for an object type
istd::IPolymorphic* obj = GetDocument();
helpPath = helpProvider->GetHelpFilePath("", obj);

See also

IHelpInfoProvider, IHelpViewer, CStaticHelpFileProviderComp, CDoxygenHelpFileProviderComp

Definition at line 47 of file IHelpFileProvider.h.

Member Function Documentation

GetHelpFilePath()

virtual QString idoc::IHelpFileProvider::GetHelpFilePath ( const QString &  contextText, const istd::IPolymorphic *  contextObjectPtr  ) const

pure virtual

Get access to help file path for specified help information.

Parameters

contextText	Text describing the help context.
contextObjectPtr	Optional pointer to object needing help.

Returns

Full file path to help document (typically HTML), or empty string if no help file found.

The returned path can be used to load and display the help content in a browser or viewer.

Implemented in iqtdoc::CDoxygenHelpFileProviderComp, and iqtdoc::CStaticHelpFileProviderComp.

---

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

• Acf/Include/idoc/IHelpFileProvider.h