CHtmlHelpGuiComp.h

Go to the documentation of this file.

/********************************************************************************
**  This file is part of the ICF Framework. Copyright (C) Witold Gantzke & Kirill Lepskiy
**  ICF Framework may be used under the terms of the LGPL License v. 2.1 by the Free Software Foundation.
********************************************************************************/
 
#pragma once
 
 
// Qt includes
#include <QtCore/QtGlobal>
#include <QtWidgets/QTextBrowser>
 
// ICF includes
#include <istdgui/TGuiComponentBase.h>
#include <idoc/IHelpViewer.h>
#include <idoc/IHelpFileProvider.h>
 
 
namespace idocgui
{
 
 
class CHtmlHelpGuiComp:
            public istdgui::TGuiComponentBase<QTextBrowser>,
            virtual public idoc::IHelpViewer
{
public:
    typedef istdgui::TGuiComponentBase<QTextBrowser> BaseClass;
 
    I_BEGIN_COMPONENT(CHtmlHelpGuiComp);
        I_REGISTER_INTERFACE(idoc::IHelpInfoProvider);
        I_REGISTER_INTERFACE(idoc::IHelpViewer);
        I_ASSIGN(m_helpFileProviderCompPtr, "HelpFileProvider", "Calculate path of html document", true, "HelpFileProvider");
    I_END_COMPONENT;
 
    // reimplemented (idoc::IHelpInfoProvider)
    double GetHelpQuality(const QString& contextText, const istd::IPolymorphic* contextObjectPtr) const override;
 
    // reimplemented (idoc::IHelpViewer)
    void ShowHelp(const QString& contextText, const istd::IPolymorphic* contextObjectPtr) override;
 
    // reimplemented (istdgui::CGuiComponentBase)
    void OnGuiCreated() override;
    void OnGuiShown() override;
 
private:
    I_REF(idoc::IHelpFileProvider, m_helpFileProviderCompPtr);
 
    mutable QUrl m_urlToShow;
};
 
 
} // namespace idocgui