helpview.h

Go to the documentation of this file.

#pragma once

/*+
________________________________________________________________________

 (C) dGB Beheer B.V.; (LICENSE) http://opendtect.org/OpendTect_license.txt
 Author:        A.H. Bril
 Date:          18-8-2000
________________________________________________________________________

-*/


#include "generalmod.h"
#include "bufstring.h"
#include "factory.h"

class HelpKey;


mExpClass(General) HelpProvider
{
public:
                        mDefineFactoryInClass(HelpProvider,factory);
    virtual             ~HelpProvider()                         {}

    static void         provideHelp(const HelpKey&);
    static bool         hasHelp(const HelpKey&);


private:
    virtual bool        hasHelp(const char* arg) const          = 0;
    virtual void        provideHelp(const char* arg) const      = 0;
};


/* Key to contain both a helpprovidername and an argument */
mExpClass(General) HelpKey
{
public:
                        HelpKey(const char* providername,const char* arg)
                            : providername_( providername ), argument_(arg) {}
                        HelpKey() : providername_( 0 )                      {}

    static HelpKey      emptyHelpKey();
    bool                isEmpty() const;

    const char*         providername_;
    BufferString        argument_;


                        //This constructor is for legacy stuff. Remove.
                        HelpKey(const char* arg)
                            : providername_("od")
                            , argument_( arg )
                        {}
};

#define mODHelpKey( arg ) HelpKey( "od", ::toString(arg) )