#include <CHtmlHelpGuiComp.h>

Inheritance diagram for idocgui::CHtmlHelpGuiComp:

Collaboration diagram for idocgui::CHtmlHelpGuiComp:

Public Types
typedef istdgui::TGuiComponentBase< QTextBrowser >	BaseClass

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

Public Types inherited from istdgui::CGuiComponentBase
typedef ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >	BaseClass

Public Types inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
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.

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

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

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

virtual QTextBrowser *	GetQtWidget () const

Public Member Functions inherited from istdgui::CGuiComponentBase
	CGuiComponentBase ()

bool	IsGuiShown () const

bool	IsGuiCreated () const override
	Inform if GUI was initilized.

bool	CreateGui (QWidget *parentPtr) override
	Initialize GUI and connect it to the parent.

bool	DestroyGui () override
	Release GUI and disconnect it from parent.

QWidget *	GetWidget () const override
	Get access to internal QWidget object.

void	OnTryClose (bool *ignoredPtr=nullptr) override
	Called on trying to close application.

Public Member Functions inherited from ibase::TVisualChangesHandlerWrap< icomp::CComponentBase >
	TVisualChangesHandlerWrap (Args &&... args)

virtual void	EnableVisualChangesHandler (bool enableLocalization=true)
	If enabled, listen to the language change event from the application 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 istdgui::IGuiObject
Public Member Functions inherited from idoc::IHelpViewer
Public Member Functions inherited from idoc::IHelpInfoProvider

Additional Inherited Members
Static Public Member Functions inherited from istdgui::CGuiComponentBase
static void	MakeAutoSlotConnection (const QWidget &widget, QObject &object)

Protected Member Functions inherited from istdgui::TGuiComponentBase< QTextBrowser >
virtual QWidget *	CreateQtWidget (QWidget *parentPtr)
	Create slave widget object.

Protected Member Functions inherited from istdgui::CGuiComponentBase
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	OnLanguageChanged () override

void	OnDesignSchemaChanged () override

bool	eventFilter (QObject sourcePtr, QEvent eventPtr) override

void	OnComponentCreated () override

void	OnComponentDestroyed () override

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

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())

Protected Attributes inherited from istdgui::CGuiComponentBase
istd::CMainThreadCaller	m_updateGuiCaller

imod::TModelWrap< VisualStatus >	m_visualStatus

Detailed Description

Definition at line 23 of file CHtmlHelpGuiComp.h.

Member Typedef Documentation

◆ BaseClass

istdgui::TGuiComponentBase<QTextBrowser> idocgui::CHtmlHelpGuiComp::BaseClass

Definition at line 28 of file CHtmlHelpGuiComp.h.

Member Function Documentation

◆ GetHelpQuality()

double idocgui::CHtmlHelpGuiComp::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.

Implements idoc::IHelpInfoProvider.