Game Develop Core: gd::HelpFileAccess Class Reference

| Game Develop Core Core library for developing platforms and tools compatible with Game Develop.

- Main Page
- Modules
- Classes

- Class List
- Class Index
- Class Hierarchy

All Classes Files Functions Variables Typedefs Enumerations Macros Groups Pages
Public Member Functions | Static Public Member Functions | List of all members
gd::HelpFileAccess Class Reference

Tool class to provide a link between the platforms implementations and the IDE, which is responsible for displaying the help. More...

`#include <HelpFileAccess.h>`

## Public Member Functions

void | SetHelpProvider (HelpProvider *newHelpProvider)
| Initialize the help controller with the specified help provider. More...
void | OpenURL (wxString url)

## Static Public Member Functions

static HelpFileAccess * | GetInstance ()
static void | DestroySingleton ()

## Detailed Description

Tool class to provide a link between the platforms implementations and the IDE, which is responsible for displaying the help.

Usage example:

gd::HelpFileAccess::GetInstance()->DisplayURL(_("www.mywebsite.com/wiki/help_about_my_topic");

## Member Function Documentation

void gd::HelpFileAccess::OpenURL | ( | wxString | url) |  |

inline

Ask the IDE to display the specified URL as help.

void gd::HelpFileAccess::SetHelpProvider | ( | HelpProvider * | newHelpProvider) |  |

inline

Initialize the help controller with the specified help provider.

This method is usually called by the IDE itself.

Warning
  The caller is responsible of newHelpProvider and must deleted it if needed ( when application is closed notably or if a new help provider is set )

See Also
  gd::HelpProvider

The documentation for this class was generated from the following files:

- HelpFileAccess.h
- HelpFileAccess.cpp