Inheritance diagram for idocgui::CHtmlHelpViewerComp:

Collaboration diagram for idocgui::CHtmlHelpViewerComp:

Public Types
typedef icomp::CComponentBase	BaseClass

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

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

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

	CComponentBase (const CComponentBase &)=delete

CComponentBase &	operator= (const CComponentBase &)=delete

virtual const ICompositeComponent *	GetParentComponent (bool ownerOnly=false) const
	Get parent of this component.

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

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

virtual void	SetComponentContext (const IComponentContext contextPtr, const ICompositeComponent parentPtr, bool isParentOwner)
	Set component context of this component.

Public Member Functions inherited from icomp::IComponent
Public Member Functions inherited from idoc::IHelpViewer
Public Member Functions inherited from idoc::IHelpInfoProvider

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

virtual void	OnComponentCreated ()

virtual void	OnComponentDestroyed ()

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

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

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

Detailed Description

Definition at line 23 of file CHtmlHelpViewerComp.h.

Member Typedef Documentation

Definition at line 28 of file CHtmlHelpViewerComp.h.

double idocgui::CHtmlHelpViewerComp::GetHelpQuality	(	const QString &	contextText,
		const istd::IPolymorphic *	contextObjectPtr ) const

overridevirtual

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.

void idocgui::CHtmlHelpViewerComp::ShowHelp	(	const QString &	contextText,
		const istd::IPolymorphic *	contextObjectPtr )

overridevirtual

Show some help information for specified context.

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