A helper class for simple use of the IApp object. More...

#include "murl_app_base.h"

Inheritance diagram for Murl::App::AppBase:

Public Member Functions
virtual Bool	Configure (IEngineConfiguration engineConfig, IFileInterface fileInterface)
	Default implementation of the IApp::Configure method; this method is empty and can be overridden. More...

virtual Bool	IsUserConfigurationMatching (const String &userConfigId) const
	Default implementation of the IApp::IsUserConfigurationMatching method; this method is empty and can be overridden; by default, no user configurations exist, so this method always returns false. More...

virtual Bool	RegisterCustomAddonClasses (IAppAddonRegistry *addonRegistry)
	Default implementation of the IApp::RegisterCustomAddonClasses method; this method is empty and can be overridden. More...

virtual Bool	UnregisterCustomAddonClasses (IAppAddonRegistry *addonRegistry)
	Default implementation of the IApp::UnregisterCustomAddonClasses method; this method is empty and can be overridden. More...

virtual Bool	RegisterCustomFactoryClasses (IAppFactoryRegistry *factoryRegistry)
	Default implementation of the IApp::RegisterCustomFactoryClasses method; this method is empty and can be overridden. More...

virtual Bool	UnregisterCustomFactoryClasses (IAppFactoryRegistry *factoryRegistry)
	Default implementation of the IApp::UnregisterCustomFactoryClasses method; this method is empty and can be overridden. More...

virtual Bool	RegisterCustomModuleClasses (IAppModuleRegistry *moduleRegistry)
	Default implementation of the IApp::RegisterCustomModuleClasses method; this method is empty and can be overridden. More...

virtual Bool	UnregisterCustomModuleClasses (IAppModuleRegistry *moduleRegistry)
	Default implementation of the IApp::UnregisterCustomModuleClasses method; this method is empty and can be overridden. More...

Public Member Functions inherited from Murl::IApp
virtual Bool	Init (const IAppState *appState)=0
	Initialize the application. More...

virtual Bool	DeInit (const IAppState *appState)=0
	Deinitialize the application. More...

Detailed Description

A helper class for simple use of the IApp object.

This class requires implementing the essential methods IApp::Configure(), IApp::Init() and IApp::DeInit() only.

Member Function Documentation

◆ Configure()

virtual Bool Murl::App::AppBase::Configure	(	IEngineConfiguration *	engineConfig,
		IFileInterface *	fileInterface
	)

inlinevirtual

Default implementation of the IApp::Configure method; this method is empty and can be overridden.

Parameters

engineConfig	The engine configuration object.
fileInterface	The file interface object.

Returns: true if successful.

Implements Murl::IApp.

◆ IsUserConfigurationMatching()

virtual Bool Murl::App::AppBase::IsUserConfigurationMatching ( const String & userConfigId ) const

inlinevirtual

Default implementation of the IApp::IsUserConfigurationMatching method; this method is empty and can be overridden; by default, no user configurations exist, so this method always returns false.

Parameters

userConfigId A string representing the user-defined configuration to be queried.

Returns: true if the current configuration is represented by the given ID.

Implements Murl::IApp.

◆ RegisterCustomAddonClasses()

virtual Bool Murl::App::AppBase::RegisterCustomAddonClasses ( IAppAddonRegistry * addonRegistry )

inlinevirtual

Default implementation of the IApp::RegisterCustomAddonClasses method; this method is empty and can be overridden.

Parameters

addonRegistry The registry to access individual add-ons.

Returns: true if successful.

Implements Murl::IApp.

◆ UnregisterCustomAddonClasses()

virtual Bool Murl::App::AppBase::UnregisterCustomAddonClasses ( IAppAddonRegistry * addonRegistry )

inlinevirtual

Default implementation of the IApp::UnregisterCustomAddonClasses method; this method is empty and can be overridden.

Parameters

addonRegistry The registry to access individual add-ons.

Returns: true if successful.

Implements Murl::IApp.

◆ RegisterCustomFactoryClasses()

virtual Bool Murl::App::AppBase::RegisterCustomFactoryClasses ( IAppFactoryRegistry * factoryRegistry )

inlinevirtual

Default implementation of the IApp::RegisterCustomFactoryClasses method; this method is empty and can be overridden.

Parameters

factoryRegistry The main registry to access individual factory registries.

Returns: true if successful.

Implements Murl::IApp.

◆ UnregisterCustomFactoryClasses()

virtual Bool Murl::App::AppBase::UnregisterCustomFactoryClasses ( IAppFactoryRegistry * factoryRegistry )

inlinevirtual

Default implementation of the IApp::UnregisterCustomFactoryClasses method; this method is empty and can be overridden.

Parameters

factoryRegistry The main registry to access individual factory registries.

Returns: true if successful.

Implements Murl::IApp.

◆ RegisterCustomModuleClasses()

virtual Bool Murl::App::AppBase::RegisterCustomModuleClasses ( IAppModuleRegistry * moduleRegistry )

inlinevirtual

Default implementation of the IApp::RegisterCustomModuleClasses method; this method is empty and can be overridden.

Parameters

moduleRegistry The main registry to access individual module registries.

Returns: true if successful.

Implements Murl::IApp.

◆ UnregisterCustomModuleClasses()

virtual Bool Murl::App::AppBase::UnregisterCustomModuleClasses ( IAppModuleRegistry * moduleRegistry )

inlinevirtual

Default implementation of the IApp::UnregisterCustomModuleClasses method; this method is empty and can be overridden.

Parameters

moduleRegistry The main registry to access individual module registries.

Returns: true if successful.

Implements Murl::IApp.

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

murl_app_base.h

Public Member Functions

Detailed Description

Member Function Documentation

◆ Configure()

◆ IsUserConfigurationMatching()

◆ RegisterCustomAddonClasses()

◆ UnregisterCustomAddonClasses()

◆ RegisterCustomFactoryClasses()

◆ UnregisterCustomFactoryClasses()

◆ RegisterCustomModuleClasses()

◆ UnregisterCustomModuleClasses()