CDoxygenHelpFileProviderComp.h
Go to the documentation of this file.
1 #ifndef iqtdoc_CDoxygenHelpFileProviderComp_included
2 #define iqtdoc_CDoxygenHelpFileProviderComp_included
3 
4 
5 #include <icomp/CComponentBase.h>
6 
8 
9 #include <iqtdoc/iqtdoc.h>
10 
11 
12 namespace iqtdoc
13 {
14 
15 
17  public icomp::CComponentBase,
18  virtual public idoc::IHelpFileProvider
19 {
20 public:
22 
23  I_BEGIN_COMPONENT(CDoxygenHelpFileProviderComp);
24  I_REGISTER_INTERFACE(idoc::IHelpFileProvider);
25  I_ASSIGN(m_doxygenDirectoryAttrPtr, "DoxygenDirectory", "Specify the directory where doxygen directory can be find", true, "./Doxygen");
26  I_ASSIGN(m_slaveProvider, "SlaveProvider", "Slave help file path provider", false, "SlaveProvider");
27  I_END_COMPONENT;
28 
29  // reimplemented (idoc::IHelpFileProvider)
30  virtual double GetHelpQuality(const QString& contextText, const istd::IPolymorphic* contextObjectPtr) const;
31  virtual QString GetHelpFilePath(const QString& contextText, const istd::IPolymorphic* contextObjectPtr) const;
32 
33 protected:
34  virtual istd::CClassInfo CalcClassInfo(const QString& contextText, const istd::IPolymorphic* contextObjectPtr) const;
35  QString CalcFilePath(const istd::CClassInfo& classInfo) const;
36 
37 private:
38  I_ATTR(QString, m_doxygenDirectoryAttrPtr);
39  I_REF(idoc::IHelpFileProvider, m_slaveProvider);
40 };
41 
42 
43 } // namespace iqtdoc
44 
45 
46 #endif // !iqtdoc_CDoxygenHelpFileProviderComp_included
47 
48 
Base class for component implementation.
Allow to show help document to specified object or text.
virtual istd::CClassInfo CalcClassInfo(const QString &contextText, const istd::IPolymorphic *contextObjectPtr) const
virtual double GetHelpQuality(const QString &contextText, const istd::IPolymorphic *contextObjectPtr) const
Get quality of help information for specified context and/or object.
Base interface for all used interfaces and implementations.
Definition: IPolymorphic.h:17
Represents platform independent type info and provide set of static class manipulation functions...
Definition: CClassInfo.h:22
QString CalcFilePath(const istd::CClassInfo &classInfo) const
virtual QString GetHelpFilePath(const QString &contextText, const istd::IPolymorphic *contextObjectPtr) const
Get access to help file path for specified help information.

© 2007-2017 Witold Gantzke and Kirill Lepskiy