Blam::Modules::Keystone Namespace Reference

Namespace containing functions from the Keystone library. More...

Functions
BLAM BlamResult	SetupModule ()
	Sets up the module and loads all necessary functions for calling. More...
BLAM void	ShutdownModule ()
	Shuts down the module and releases any data used by it. More...
BLAM HMODULE	GetKeystoneModuleHandle ()
	Retrieves the module handle for the Keystone library. More...
BLAM int	ShowErrorDialog (bool allow_safemode, bool allow_continue, const char *text)
	Shows a Qt-driven error dialog. More...
BLAM bool	OpenWebURL (std::string url)
	Opens a URL in the user's default web browser. More...
BLAM bool	OpenLocalURL (std::string url)
	Opens a local file with the user's default application. More...

Detailed Description

Namespace containing functions from the Keystone library.

Function Documentation

GetKeystoneModuleHandle()

HMODULE Blam::Modules::Keystone::GetKeystoneModuleHandle

(

)

Retrieves the module handle for the Keystone library.

Returns

The module handle for the Keystone library, or nullptr if the module is not yet loaded.

OpenLocalURL()

bool Blam::Modules::Keystone::OpenLocalURL

(

std::string

url

)

Opens a local file with the user's default application.

Parameters

url	- The file path to open.

Deprecated:

Move this functionality into Strings, then remove.

Here is the caller graph for this function:

OpenWebURL()

bool Blam::Modules::Keystone::OpenWebURL

(

std::string

url

)

Opens a URL in the user's default web browser.

Parameters

url	- The URL to open.

Deprecated:

Move this functionality into Strings, then remove.

Here is the caller graph for this function:

SetupModule()

BlamResult Blam::Modules::Keystone::SetupModule

(

)

Sets up the module and loads all necessary functions for calling.

Returns

BlamResult::Success_OK if the module initialized successfully, otherwise returns an error code.

Here is the call graph for this function:

Here is the caller graph for this function:

ShowErrorDialog()

int Blam::Modules::Keystone::ShowErrorDialog	(	bool	allow_safemode,
		bool	allow_continue,
		const char *	text
	)

Shows a Qt-driven error dialog.

It is a reimplementation of the original Win32 error dialog.

Parameters

allow_safemode	- Whether or not to enable the 'Continue in Safe Mode' option.
allow_continue	- Wehther or not to enable the 'Continue' option.
text	- The message to display to the user.

Returns

The return code of the error dialog.

Here is the caller graph for this function:

ShutdownModule()

void Blam::Modules::Keystone::ShutdownModule

(

)

Shuts down the module and releases any data used by it.

Here is the caller graph for this function: