Guerilla::Modules::Keystone Namespace Reference

Namespace containing functions related to the Keystone module, as well as any imported functions from Keystone. More...

Functions
GUERILLA bool	SetupModule ()
	Attempts to initialize the Keystone module and import any needed functions. More...
GUERILLA void	ShutdownModule ()
	Shuts down the Keystone module. More...
GUERILLA HMODULE	GetKeystoneModuleHandle ()
	Retrieves the module handle for Keystone. More...
GUERILLA int	ShowErrorDialog (bool classic, bool allow_safemode, bool allow_continue, const char *text)
	Shows a Qt-driven error dialog. More...
GUERILLA int	ShowGuerillaWindow (BlamConfigurationFile *config)
	Shows the main Guerilla window. More...
GUERILLA BlamResult	LoadResourceGroup (std::string file_path)
	Loads a resource group for use with Keystone's UI. More...

Detailed Description

Namespace containing functions related to the Keystone module, as well as any imported functions from Keystone.

Function Documentation

GetKeystoneModuleHandle()

HMODULE Guerilla::Modules::Keystone::GetKeystoneModuleHandle

(

)

Retrieves the module handle for Keystone.

Returns

The module handle for Keystone.

LoadResourceGroup()

BlamResult Guerilla::Modules::Keystone::LoadResourceGroup

(

std::string

file_path

)

Loads a resource group for use with Keystone's UI.

Parameters

file_path

- The path to the resource file to load.

Returns

#BlamResult::Success_OK if the resource file was loaded successfully, otherwise returns an error code.

SetupModule()

bool Guerilla::Modules::Keystone::SetupModule

(

)

Attempts to initialize the Keystone module and import any needed functions.

Returns

true if the module was loaded successfully, otherwise returns `false.

ShowErrorDialog()

int Guerilla::Modules::Keystone::ShowErrorDialog	(	bool	classic,
		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

classic	- Whether or not to display the dialog with a classic appearance.
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.

Todo:

Have return value changed over to use #KeystoneDialogResult instead.

ShowGuerillaWindow()

int Guerilla::Modules::Keystone::ShowGuerillaWindow

(

BlamConfigurationFile *

config

)

Shows the main Guerilla window.

Parameters

config

- Pointer to the Guerilla configuration file.

Returns

The Qt application execution result.

ShutdownModule()

void Guerilla::Modules::Keystone::ShutdownModule

(

)

Shuts down the Keystone module.