uihelpview.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        K. Tingdahl
 Date:          March 2014
________________________________________________________________________

-*/

#include <uibasemod.h>

#include "helpview.h"
#include "iopar.h"


mExpClass(uiBase) SimpleHelpProvider : public HelpProvider
{
protected:
                        SimpleHelpProvider(const char* urlbase,
                                           const char* keylinkfile=0);

    void                addKeyLink(const char* key,const char* link);

private:

    virtual bool        hasHelp(const char* arg) const;
    virtual void        provideHelp(const char* arg) const;

    BufferString        baseurl_;
    IOPar               keylinks_;

};


mExpClass(uiBase) FlareHelpProvider : public HelpProvider
{  mODTextTranslationClass(FlareHelpProvider);
public:
    static void                 initClass(const char* factorykey,
                                          const char* baseurl);

    static void                 initODHelp();

private:
                                FlareHelpProvider(const char* url);
    static HelpProvider*        createInstance();

    void                        provideHelp(const char*) const;
    bool                        hasHelp(const char*) const { return true; }
    BufferString                baseurl_;

public:
                                //Internal to dGB
    static void                 initHelpSystem(const char* context,
                                               const char* path);
};


mExpClass(uiBase) DevDocHelp : public HelpProvider
{ mODTextTranslationClass(DevDocHelp);
public:
    static void         initClass();

    static const char*          sKeyFactoryName() { return "oddevdoc"; }

private:
    BufferString                getUrl() const;
    static HelpProvider*        createInstance();
    bool                        hasHelp(const char* arg) const;
    void                        provideHelp(const char* arg) const;
};

mExpClass(uiBase) WebsiteHelp : public HelpProvider
{ mODTextTranslationClass(WebsiteHelp);
public:
    static void         initClass();
    static const char*          sKeyFactoryName();
    static const char*          sKeySupport();
    static const char*          sKeyAttribMatrix();

private:
    static HelpProvider*        createInstance();
    bool                        hasHelp(const char* arg) const;
    void                        provideHelp(const char* arg) const;
};