HelpProvider Class Reference

Inheritance diagram for HelpProvider:

Public Member Functions
	mDefineFactoryInClass (HelpProvider, factory)
virtual	~HelpProvider ()

Static Public Member Functions
static void	provideHelp (const HelpKey &)
static bool	hasHelp (const HelpKey &)

Private Member Functions
virtual bool	hasHelp (const char *arg) const =0
virtual void	provideHelp (const char *arg) const =0

Detailed Description

The generalization of a provider that can provide help in some way. Each provider is identified by an providername, and an argument (encapsulated in an HelpKey). The providername is used to create a HelpProvider, and the argument is given to it to produce a help.

Constructor & Destructor Documentation

virtual HelpProvider::~HelpProvider ( )

inlinevirtual

Member Function Documentation

static bool HelpProvider::hasHelp ( const HelpKey &  )

static

virtual bool HelpProvider::hasHelp ( const char *  arg ) const

privatepure virtual

Implemented in WebsiteHelp, DevDocHelp, FlareHelpProvider, and SimpleHelpProvider.

HelpProvider::mDefineFactoryInClass	(	HelpProvider	,
		factory
	)

static void HelpProvider::provideHelp ( const HelpKey &  )

static

virtual void HelpProvider::provideHelp ( const char *  arg ) const

privatepure virtual

Implemented in WebsiteHelp, DevDocHelp, FlareHelpProvider, and SimpleHelpProvider.