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
 RCS:           $Id$
________________________________________________________________________
 
-*/
 
 
#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&);
    static uiString     description(const HelpKey&);
 
private:
    virtual bool        hasHelp(const char* arg) const          = 0;
    virtual void        provideHelp(const char* arg) const      = 0;
    virtual uiString    description(const char* arg) const;
};
 
 
/* 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 )          {}
 
    bool                operator==(const HelpKey&) const;
    static HelpKey      emptyHelpKey();
    bool                isEmpty() const;
 
    BufferString        providername_;
    BufferString        argument_;
 
                        // Legacy
                        HelpKey(const char* arg)
                            : providername_("od")
                            , argument_( arg )
                        {}
 
                        mDeprecated("Use the constructor")
    static HelpKey      makeFromString(const char*);
};
 
#define mODHelpKey( arg ) HelpKey( "od", ::toString(arg) )
#define mODVideoKey( arg ) HelpKey( "odvideo", ::toString(arg) )