Murl::IAppAddonRegistry Interface Referenceabstract

The add-on registry interface. More...

#include "murl_i_app_addon_registry.h"

Inherited by Murl::Core::AppAddonRegistry.

Public Member Functions

virtual Bool RegisterAddon (IAddonPtr addon)=0
 Register an add-on. More...
 
virtual Bool UnregisterAddon (IAddonPtr addon)=0
 Unregister an add-on. More...
 
virtual UInt32 GetNumberOfRegisteredAddons () const =0
 Get the number of registered an add-ons. More...
 
virtual IAddonPtr GetRegisteredAddon (UInt32 index) const =0
 Get a registered add-on. More...
 

Detailed Description

The add-on registry interface.

An add-on represents an optionally linkable component that can be used to extend the engine's functionality, e.g. the Facebook integration.
Add-ons are typically registered by the application in IApp::RegisterCustomAddonClasses() and unregistered in IApp::UnregisterCustomAddonClasses().

Member Function Documentation

◆ RegisterAddon()

virtual Bool Murl::IAppAddonRegistry::RegisterAddon ( IAddonPtr  addon)
pure virtual

Register an add-on.

Parameters
addonThe add-on to register.
Returns
true if successful.

◆ UnregisterAddon()

virtual Bool Murl::IAppAddonRegistry::UnregisterAddon ( IAddonPtr  addon)
pure virtual

Unregister an add-on.

Parameters
addonThe add-on to unregister.
Returns
true if successful.

◆ GetNumberOfRegisteredAddons()

virtual UInt32 Murl::IAppAddonRegistry::GetNumberOfRegisteredAddons ( ) const
pure virtual

Get the number of registered an add-ons.

Returns
The number of registered an add-ons.

◆ GetRegisteredAddon()

virtual IAddonPtr Murl::IAppAddonRegistry::GetRegisteredAddon ( UInt32  index) const
pure virtual

Get a registered add-on.

A valid add-on index is [0 .. GetNumberOfRegisteredAddons() - 1].

Parameters
indexThe zero-based index of the add-on.
Returns
The registered add-on or null if index is out of range.

The documentation for this interface was generated from the following file:
  • murl_i_app_addon_registry.h


Copyright © 2011-2018 Spraylight GmbH.