Public Types | Public Member Functions | List of all members
iqtdoc::CHtmlHelpGuiComp Class Reference

#include <CHtmlHelpGuiComp.h>

Inheritance diagram for iqtdoc::CHtmlHelpGuiComp:
iqtgui::TGuiComponentBase< QTextBrowser > idoc::IHelpViewer iqtgui::CGuiComponentBase idoc::IHelpInfoProvider ibase::TLocalizableWrap< icomp::CComponentBase > iqtgui::IGuiObject istd::IPolymorphic icomp::CComponentBase istd::IPolymorphic icomp::IComponent istd::IPolymorphic

Public Types

typedef
iqtgui::TGuiComponentBase
< QTextBrowser > 
BaseClass
 
- Public Types inherited from iqtgui::TGuiComponentBase< QTextBrowser >
typedef CGuiComponentBase BaseClass
 
- Public Types inherited from iqtgui::CGuiComponentBase
typedef icomp::CComponentBase BaseClass
 
- Public Types inherited from ibase::TLocalizableWrap< icomp::CComponentBase >
typedef icomp::CComponentBase BaseClass
 

Public Member Functions

virtual double GetHelpQuality (const QString &contextText, const istd::IPolymorphic *contextObjectPtr) const
 Get quality of help information for specified context and/or object. More...
 
virtual void ShowHelp (const QString &contextText, const istd::IPolymorphic *contextObjectPtr)
 Show some help information for specified context. More...
 
virtual void OnGuiShown ()
 Called from widget event filter when slave widget is shown. More...
 
- Public Member Functions inherited from iqtgui::TGuiComponentBase< QTextBrowser >
 TGuiComponentBase ()
 
virtual QTextBrowser * GetQtWidget () const
 
virtual QWidget * CreateQtWidget (QWidget *parentPtr)
 Create slave widget object. More...
 
- 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
 Inform if GUI was initilized. More...
 
virtual bool CreateGui (QWidget *parentPtr)
 Initialize GUI and connect it to the parent. More...
 
virtual bool DestroyGui ()
 Release GUI and disconnect it from parent. More...
 
virtual QWidget * GetWidget () const
 Get access to internal QWidget object. More...
 
virtual void OnTryClose (bool *ignoredPtr=NULL)
 Called on trying to close application. More...
 
- Public Member Functions inherited from ibase::TLocalizableWrap< icomp::CComponentBase >
 TLocalizableWrap ()
 
virtual void EnableLocalization (bool enableLocalization=true)
 If enabled, listen to the language change event from the application context. More...
 
- Public Member Functions inherited from icomp::CComponentBase
 CComponentBase ()
 Create component and assign it to specific context. More...
 
virtual const ICompositeComponentGetParentComponent (bool ownerOnly=false) const
 Get parent of this component. More...
 
virtual void * GetInterface (const istd::CClassInfo &interfaceType, const QByteArray &subId="")
 Get access to specified component interface. More...
 
virtual const IComponentContextGetComponentContext () const
 Get access to component context describing all application-specified component information loaded from components registry. More...
 
virtual void SetComponentContext (const icomp::IComponentContext *contextPtr, const ICompositeComponent *parentPtr, bool isParentOwner)
 Set component context of this component. More...
 
- Public Member Functions inherited from istd::IPolymorphic
virtual ~IPolymorphic ()
 

Additional Inherited Members

- Protected Member Functions inherited from iqtgui::CGuiComponentBase
virtual void OnGuiHidden ()
 Called from widget event filter when slave widget is hidden. More...
 
virtual bool OnKeyPressed (QKeyEvent *event)
 Called from widget event filter when key is pressed. More...
 
virtual void OnRetranslate ()
 Called when non-GUI elements (like commands) should be retranslated. More...
 
virtual void OnGuiRetranslate ()
 Called from widget event filter when GUI should be retranslated. More...
 
virtual void OnGuiCreated ()
 Called just after GUI is initialized. More...
 
virtual void OnGuiDestroyed ()
 Called just before GUI is released. More...
 
void SetStatusIcon (const QIcon &icon)
 Set status icon;. More...
 
void SetStatusText (const QString &text)
 Set status text;. More...
 
virtual void OnLanguageChanged ()
 
virtual bool eventFilter (QObject *sourcePtr, QEvent *eventPtr)
 
virtual void OnComponentCreated ()
 
- Protected Member Functions inherited from icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active. More...
 
virtual void OnComponentDestroyed ()
 
virtual const
icomp::IRealComponentStaticInfo
GetComponentStaticInfo () const =0
 Get access to static info of this component. More...
 
- 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())
 
- Protected Attributes inherited from iqtgui::CGuiComponentBase
imod::TModelWrap< VisualStatusm_visualStatus
 

Detailed Description

Definition at line 25 of file CHtmlHelpGuiComp.h.

Member Typedef Documentation

Definition at line 30 of file CHtmlHelpGuiComp.h.

Member Function Documentation

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

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.

virtual void iqtdoc::CHtmlHelpGuiComp::OnGuiShown ( )
virtual

Called from widget event filter when slave widget is shown.

Reimplemented from iqtgui::CGuiComponentBase.

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

Show some help information for specified context.

Implements idoc::IHelpViewer.


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy