HTML-based help viewer component. More...

#include <CHtmlHelpGuiComp.h>

Inheritance diagram for iqtdoc::CHtmlHelpGuiComp:

Public Types
typedef iqtgui::TGuiComponentBase< QTextBrowser >	BaseClass

Public Types inherited from iqtgui::TGuiComponentBase< QTextBrowser >
typedef CGuiComponentBase	BaseClass

Public Types inherited from iqtgui::CGuiComponentBase
typedef TMakeIconProviderCompWrap< ibase::TLocalizableWrap< icomp::CComponentBase > >	BaseClass

Public Types inherited from iqtgui::TMakeIconProviderCompWrap< ibase::TLocalizableWrap< icomp::CComponentBase > >
typedef ibase::TLocalizableWrap< icomp::CComponentBase >	BaseClass

Public Types inherited from iqtgui::TDesignSchemaHandlerWrap< Base >
typedef Base	BaseClass

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

virtual void	ShowHelp (const QString &contextText, const istd::IPolymorphic *contextObjectPtr) override
	Show some help information for specified context.

virtual void	OnGuiCreated () override
	Called just after GUI is initialized.

virtual void	OnGuiShown () override
	Called from widget event filter when slave widget is shown.

Public Member Functions inherited from iqtgui::TGuiComponentBase< QTextBrowser >
	TGuiComponentBase ()

virtual QTextBrowser *	GetQtWidget () const

virtual QWidget *	CreateQtWidget (QWidget *parentPtr) override
	Create slave widget object.

Public Member Functions inherited from iqtgui::CGuiComponentBase
	I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, IVisualStatus, ExtractVisualStatus)

	I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, istd::IChangeable, ExtractVisualStatus)

	I_REGISTER_SUBELEMENT_INTERFACE_T (VisualStatus, imod::IModel, ExtractVisualStatus)

	CGuiComponentBase ()

bool	IsGuiShown () const

virtual bool	IsGuiCreated () const override
	Checks if the GUI has been initialized and created.

virtual bool	CreateGui (QWidget *parentPtr) override
	Initializes the GUI and connects it to the parent widget.

virtual bool	DestroyGui () override
	Releases GUI resources and disconnects from the parent.

virtual QWidget *	GetWidget () const override
	Gets access to the internal QWidget object.

virtual void	OnTryClose (bool *ignoredPtr=NULL) override
	Called when the application is attempting to close.

Public Member Functions inherited from iqtgui::TDesignSchemaHandlerWrap< Base >
	TDesignSchemaHandlerWrap ()

virtual void	EnableDesignHandler (bool enable=true)
	If enabled, listen to the design schema change events from the application context.

Public Member Functions inherited from iqtgui::CIconProvider
virtual QIcon	GetIcon (const QString &iconName) const

virtual QString	GetIconPath (const QString &iconName) const

virtual QString	GetStyleSheetPath (const QString &styleSheetPath) const

QByteArray	GetCurrentThemeId () const

void	SetThemeId (const QByteArray &themeId)

Public Member Functions inherited from istd::IPolymorphic
virtual	~IPolymorphic ()

Additional Inherited Members
Protected Member Functions inherited from iqtgui::CGuiComponentBase
virtual void	OnGuiDesignChanged ()

virtual void	OnGuiHidden ()
	Called from widget event filter when slave widget is hidden.

virtual bool	OnKeyPressed (QKeyEvent *event)
	Called from widget event filter when key is pressed.

virtual void	OnRetranslate ()
	Called when non-GUI elements (like commands) should be retranslated.

virtual void	OnGuiRetranslate ()
	Called from widget event filter when GUI should be retranslated.

virtual void	OnGuiDestroyed ()
	Called just before GUI is released.

void	SetStatusIcon (const QIcon &icon)
	Set status icon;.

void	SetStatusText (const QString &text)
	Set status text;.

void	SetDefaultVisualStatus ()

virtual void	OnLanguageChanged () override

virtual void	OnDesignSchemaChanged (const QByteArray &themeId) override

virtual bool	eventFilter (QObject sourcePtr, QEvent eventPtr) override

virtual void	OnComponentCreated () override

virtual void	OnComponentDestroyed () override

Protected Member Functions inherited from iqtgui::CIconProvider
virtual QIcon	CreateIcon (const QString &iconName) const

Protected Attributes inherited from iqtgui::CGuiComponentBase
imod::TModelWrap< VisualStatus >	m_visualStatus

Detailed Description

HTML-based help viewer component.

Provides a Qt-based HTML help viewer that can display HTML documentation files. The component uses QTextBrowser to render HTML content and integrates with the ACF help system through IHelpViewer interface.

This component is typically used to display:

Doxygen-generated documentation
Static HTML help files
Context-sensitive help
Application documentation

Component References

HelpFileProvider - Component that resolves help context to file paths (required)

Registered Interfaces

idoc::IHelpInfoProvider - Reports help availability
idoc::IHelpViewer - Displays help content

Configuration Example: CHtmlHelpGuiComp {

HelpFileProvider = CDoxygenHelpFileProviderComp {

HelpDirectory = "doc/html"

IndexFileName = "index.html"

}

}

iqtdoc::CDoxygenHelpFileProviderComp
Definition CDoxygenHelpFileProviderComp.h:18

iqtdoc::CHtmlHelpGuiComp
HTML-based help viewer component.
Definition CHtmlHelpGuiComp.h:107

Alternative Configuration with Static Help: CHtmlHelpGuiComp {

HelpFileProvider = CStaticHelpFileProviderComp {

HelpDirectory = "help"

HelpFileExtension = "html"

}

}

iqtdoc::CStaticHelpFileProviderComp
Definition CStaticHelpFileProviderComp.h:18

Usage in Main Window: CMainWindowGuiComp {

// Main window will automatically use help viewer if available

HelpViewer = CHtmlHelpGuiComp {

HelpFileProvider = MyHelpProvider

}

}

iqtdoc::CMainWindowGuiComp
Standard main window component for any document-based application.
Definition CMainWindowGuiComp.h:187

Programmatic Usage: // Get help viewer instance

idoc::IHelpViewer* helpViewer = GetHelpViewer();

// Show help for a topic

helpViewer->ShowHelp("IDocumentManager", nullptr);

// Show help for current widget

QWidget* widget = GetCurrentWidget();

helpViewer->ShowHelp("", widget);

// Check if help is available before showing

double quality = helpViewer->GetHelpQuality("SomeClass", nullptr);

if (quality > 0.5) {

helpViewer->ShowHelp("SomeClass", nullptr);

}

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

idoc::IHelpViewer
Allow to show help document to specified object or text.
Definition IHelpViewer.h:45

idoc::IHelpViewer::ShowHelp
virtual void ShowHelp(const QString &contextText, const istd::IPolymorphic *contextObjectPtr)=0
Show some help information for specified context.

The component features:

Automatic URL resolution through help file provider
HTML content rendering with QTextBrowser
Navigation history (back/forward)
Link following
Print support (via QTextBrowser capabilities)

See also: IHelpViewer, IHelpFileProvider, CDoxygenHelpFileProviderComp, CStaticHelpFileProviderComp

Definition at line 104 of file CHtmlHelpGuiComp.h.

Member Typedef Documentation

◆ BaseClass

typedef iqtgui::TGuiComponentBase<QTextBrowser> iqtdoc::CHtmlHelpGuiComp::BaseClass

Definition at line 109 of file CHtmlHelpGuiComp.h.

Member Function Documentation

◆ GetHelpQuality()

virtual double iqtdoc::CHtmlHelpGuiComp::GetHelpQuality	(	const QString &	contextText,
		const istd::IPolymorphic *	contextObjectPtr
	)		const

overridevirtual

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

Parameters

contextText	Text describing the help context (e.g., class name, topic).
contextObjectPtr	Optional pointer to object needing help.

Returns

Quality of help represented as value in range [0, 1].

0 means there is no usable help
1 means good context-specific help is available
Values in between indicate partial or generic help availability

Either contextText or contextObjectPtr can be provided, or both. The help provider uses these to determine if relevant help exists.

Implements idoc::IHelpInfoProvider.

◆ OnGuiCreated()

virtual void iqtdoc::CHtmlHelpGuiComp::OnGuiCreated ( )

overridevirtual

Called just after GUI is initialized.

Reimplemented from iqtgui::CGuiComponentBase.

◆ OnGuiShown()

virtual void iqtdoc::CHtmlHelpGuiComp::OnGuiShown ( )

overridevirtual

Called from widget event filter when slave widget is shown.

Reimplemented from iqtgui::CGuiComponentBase.

◆ ShowHelp()

virtual void iqtdoc::CHtmlHelpGuiComp::ShowHelp	(	const QString &	contextText,
		const istd::IPolymorphic *	contextObjectPtr
	)

overridevirtual

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.

Implements idoc::IHelpViewer.

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

Acf/Include/iqtdoc/CHtmlHelpGuiComp.h

Public Types

Public Member Functions

Additional Inherited Members

Detailed Description

Member Typedef Documentation

◆ BaseClass

Member Function Documentation

◆ GetHelpQuality()

◆ OnGuiCreated()

◆ OnGuiShown()

◆ ShowHelp()