icmpstr::CQuickHelpGuiComp Class Reference

#include <CQuickHelpGuiComp.h>

Inheritance diagram for icmpstr::CQuickHelpGuiComp:

Collaboration diagram for icmpstr::CQuickHelpGuiComp:

Public Types
typedef istdgui::TDesignerGuiCompBase< Ui::CQuickHelpGuiComp >	BaseClass
Public Types inherited from istdgui::TGuiComponentBase< QWidget >
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.
Public Member Functions inherited from istdgui::TGuiComponentBase< QWidget >
	TGuiComponentBase ()
virtual QWidget *	GetQtWidget () const
Public Member Functions inherited from istdgui::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
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

Protected Slots
void	on_EditButton_clicked ()
void	on_NewButton_clicked ()
void	on_ShowTechButton_clicked ()

Protected Member Functions
QString	CalcDoxygenFileName (const istd::CClassInfo &classInfo) const
void	OnGuiCreated () override
	Called just after GUI is initialized.
Protected Member Functions inherited from istdgui::TGuiComponentBase< QWidget >
virtual QWidget *	CreateQtWidget (QWidget *parentPtr)
	Create slave widget object.
Protected Member Functions inherited from istdgui::CGuiComponentBase
virtual void	OnGuiShown ()
	Called from widget event filter when slave widget is shown.
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.

Additional Inherited Members
Static Public Member Functions inherited from istdgui::CGuiComponentBase
static void	MakeAutoSlotConnection (const QWidget &widget, QObject &object)
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 28 of file CQuickHelpGuiComp.h.

Member Typedef Documentation

BaseClass

istdgui::TDesignerGuiCompBase<Ui::CQuickHelpGuiComp> icmpstr::CQuickHelpGuiComp::BaseClass

Definition at line 35 of file CQuickHelpGuiComp.h.

Member Function Documentation

CalcDoxygenFileName()

QString icmpstr::CQuickHelpGuiComp::CalcDoxygenFileName ( const istd::CClassInfo & classInfo ) const

protected

GetHelpQuality()

double icmpstr::CQuickHelpGuiComp::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.

on_EditButton_clicked

void icmpstr::CQuickHelpGuiComp::on_EditButton_clicked ( )

protectedslot

on_NewButton_clicked

void icmpstr::CQuickHelpGuiComp::on_NewButton_clicked ( )

protectedslot

on_ShowTechButton_clicked

void icmpstr::CQuickHelpGuiComp::on_ShowTechButton_clicked ( )

protectedslot

OnGuiCreated()

void icmpstr::CQuickHelpGuiComp::OnGuiCreated ( )

overrideprotectedvirtual

Called just after GUI is initialized.

Reimplemented from istdgui::CGuiComponentBase.

ShowHelp()

void icmpstr::CQuickHelpGuiComp::ShowHelp ( const QString & contextText, const istd::IPolymorphic * contextObjectPtr )

overridevirtual

Show some help information for specified context.

Implements idoc::IHelpViewer.

---

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

• icmpstr/CQuickHelpGuiComp.h