#include <CDoxygenHelpFileProviderComp.h>

Inheritance diagram for iqtdoc::CDoxygenHelpFileProviderComp:

Public Types
typedef icomp::CComponentBase	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 QString	GetHelpFilePath (const QString &contextText, const istd::IPolymorphic *contextObjectPtr) const override
	Get access to help file path for specified help information.

Public Member Functions inherited from icomp::CComponentBase
	CComponentBase ()
	Create component and assign it to specific context.

virtual const icomp::IComponent *	GetParentComponent (bool ownerOnly=false) const override
	Get parent of this component.

virtual void *	GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="") override
	Get access to specified component interface.

virtual IComponentContextSharedPtr	GetComponentContext () const override
	Get access to component context describing all application-specified component information loaded from components registry.

virtual void	SetComponentContext (const IComponentContextSharedPtr &contextPtr, const icomp::IComponent *parentPtr, bool isParentOwner) override
	Set component context of this component.

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

Protected Member Functions
virtual istd::CClassInfo	CalcClassInfo (const QString &contextText, const istd::IPolymorphic *contextObjectPtr) const

QString	CalcFilePath (const istd::CClassInfo &classInfo) const

Protected Member Functions inherited from icomp::CComponentBase
bool	IsComponentActive () const
	Check if component is active.

virtual void	OnComponentCreated ()

virtual void	OnComponentDestroyed ()

virtual const icomp::IRealComponentStaticInfo &	GetComponentStaticInfo () const =0
	Get access to static info of this component.

Additional Inherited Members
Static Protected Member Functions inherited from icomp::CComponentBase
static const icomp::IRealComponentStaticInfo &	InitStaticInfo (IComponent *componentPtr)

static QByteArray	GetComponentId (const icomp::IComponentContext *componentContextPtr, const QByteArray &contextId=QByteArray())

Detailed Description

Definition at line 15 of file CDoxygenHelpFileProviderComp.h.

Member Typedef Documentation

◆ BaseClass

typedef icomp::CComponentBase iqtdoc::CDoxygenHelpFileProviderComp::BaseClass

Definition at line 20 of file CDoxygenHelpFileProviderComp.h.

Member Function Documentation

◆ CalcClassInfo()

virtual istd::CClassInfo iqtdoc::CDoxygenHelpFileProviderComp::CalcClassInfo	(	const QString &	contextText,
		const istd::IPolymorphic *	contextObjectPtr
	)		const

protectedvirtual

◆ CalcFilePath()

QString iqtdoc::CDoxygenHelpFileProviderComp::CalcFilePath ( const istd::CClassInfo & classInfo ) const

protected

◆ GetHelpFilePath()

virtual QString iqtdoc::CDoxygenHelpFileProviderComp::GetHelpFilePath	(	const QString &	contextText,
		const istd::IPolymorphic *	contextObjectPtr
	)		const

overridevirtual

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.

Implements idoc::IHelpFileProvider.

◆ GetHelpQuality()

virtual double iqtdoc::CDoxygenHelpFileProviderComp::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.

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

Acf/Include/iqtdoc/CDoxygenHelpFileProviderComp.h

Public Types

Public Member Functions

Protected Member Functions

Additional Inherited Members