A simple HelpProvider that can be extended to create a HelpProvider for third party plug-ins. You need a urlbase string which can refer to a web URL (starting with "http://") or a local file path (starting with "file:///"). For linking the individual HelpKeys, you can either add links for specific keys using the function: More...

Inheritance diagram for SimpleHelpProvider:

[legend]

Protected Member Functions
	SimpleHelpProvider (const char urlbase, const char keylinkfile=0)

void	addKeyLink (const char key, const char link)

Private Member Functions
virtual bool	hasHelp (const char *arg) const

virtual void	provideHelp (const char *arg) const

Private Attributes
BufferString	baseurl_

IOPar	keylinks_

Additional Inherited Members
Public Member Functions inherited from HelpProvider
virtual	~HelpProvider ()

Static Public Member Functions inherited from HelpProvider
static uiString	description (const HelpKey &)

static bool	hasHelp (const HelpKey &)

static void	provideHelp (const HelpKey &)

Detailed Description

A simple HelpProvider that can be extended to create a HelpProvider for third party plug-ins. You need a urlbase string which can refer to a web URL (starting with "http://") or a local file path (starting with "file:///"). For linking the individual HelpKeys, you can either add links for specific keys using the function:

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

or have a local file with key-value pairs like this:

key1: link1
key2: link2
...........

The links will be simply appended to urlbase. For example, look at the class TutHelpProvider in plugins/uiTut/uitutpi.cc

<>

Constructor & Destructor Documentation

◆ SimpleHelpProvider()

SimpleHelpProvider::SimpleHelpProvider	(	const char *	urlbase,
		const char *	keylinkfile = `0`
	)

protected

Member Function Documentation

◆ addKeyLink()

void SimpleHelpProvider::addKeyLink	(	const char *	key,
		const char *	link
	)

protected

◆ hasHelp()

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

privatevirtual

Implements HelpProvider.

◆ provideHelp()

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

privatevirtual

Implements HelpProvider.

Member Data Documentation

◆ baseurl_

BufferString SimpleHelpProvider::baseurl_

private

◆ keylinks_

IOPar SimpleHelpProvider::keylinks_