idoc::IHelpViewer Class Reference

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

#include <IHelpViewer.h>

Inheritance diagram for idoc::IHelpViewer:

Public Member Functions
virtual void	ShowHelp (const QString &contextText, const istd::IPolymorphic *contextObjectPtr)=0
	Show some help information for specified context.
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.

Extends IHelpInfoProvider to provide actual help display functionality. This is the main interface for help viewer components that can show help content to the user.

Usage Example

idoc::IHelpViewer* helpViewer = GetHelpViewer();
 
// Show help for a specific topic
helpViewer->ShowHelp("MainWindow", nullptr);
 
// Show help for an object
istd::IPolymorphic* obj = GetCurrentWidget();
helpViewer->ShowHelp("", obj);
 
// Check quality before showing
if (helpViewer->GetHelpQuality("UndoRedo", nullptr) > 0.5) {
       helpViewer->ShowHelp("UndoRedo", nullptr);
}

See also

IHelpInfoProvider, IHelpFileProvider, CHtmlHelpGuiComp

Definition at line 44 of file IHelpViewer.h.

Member Function Documentation

ShowHelp()

virtual void idoc::IHelpViewer::ShowHelp ( const QString &  contextText, const istd::IPolymorphic *  contextObjectPtr  )

pure virtual

Show some help information for specified context.

Parameters

contextText	Text describing the help context (e.g., "FileMenu", "UndoCommand").
contextObjectPtr	Optional pointer to object needing help.

This method displays help content in an appropriate viewer (browser, dialog, etc.). The implementation determines the best way to present the help based on the context.

Implemented in iqtdoc::CHtmlHelpGuiComp, and iqtdoc::CHtmlHelpViewerComp.

---

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

• Acf/Include/idoc/IHelpViewer.h