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

#include <CStaticHelpFileProviderComp.h>

Inheritance diagram for iqtdoc::CStaticHelpFileProviderComp:
icomp::CComponentBase idoc::IHelpFileProvider icomp::IComponent idoc::IHelpInfoProvider istd::IPolymorphic istd::IPolymorphic

Public Types

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 QString GetHelpFilePath (const QString &contextText, const istd::IPolymorphic *contextObjectPtr) const
 Get access to help file path for specified help information. 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 icomp::CComponentBase
bool IsComponentActive () const
 Check if component is active. More...
 
virtual void OnComponentCreated ()
 
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())
 

Detailed Description

Definition at line 15 of file CStaticHelpFileProviderComp.h.

Member Typedef Documentation

Definition at line 20 of file CStaticHelpFileProviderComp.h.

Member Function Documentation

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

Get access to help file path for specified help information.

Implements idoc::IHelpFileProvider.

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


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

© 2007-2017 Witold Gantzke and Kirill Lepskiy