BlamKeystoneAPI Namespace Reference

Namespace containing any exported functions within Keystone. More...

Functions
KEYSTONE_API int	ShowMainWindow ()
	Shows a default testing window. More...
KEYSTONE_API int	ShowErrorDialog (bool classic, bool allow_safemode, bool allow_continue, const char *text)
	Shows a Qt-driven error dialog. More...
KEYSTONE_API int	ShowSapienWindow ()
	Shows the main Sapien window. More...
KEYSTONE_API int	ShowFoundryWindow ()
	Shows the main Foundry window. More...
KEYSTONE_API int	ShowGuerillaWindow (BlamConfigurationFile *guerilla_config)
	Shows the main Guerilla window. More...
KEYSTONE_API int	ShowToolWindow ()
	Shows the Tool GUI window. More...
KEYSTONE_API bool	OpenWebURL (std::string url)
	Opens a URL in the user's default web browser. More...
KEYSTONE_API bool	OpenLocalURL (std::string url)
	Opens a local file with the user's default application. More...
KEYSTONE_API BlamResult	LoadResourceGroup (std::string file_path)
	Loads a resource group for use with Keystone's UI. More...

Detailed Description

Namespace containing any exported functions within Keystone.

Function Documentation

LoadResourceGroup()

BlamResult BlamKeystoneAPI::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.

Deprecated:

This should probably be done internally within Keystone rather than having it be called externally.

OpenLocalURL()

bool BlamKeystoneAPI::OpenLocalURL

(

std::string

url

)

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

Parameters

url	- The file path to open.

Deprecated:

I don't think we need this. Verify if we do or don't, and if not then remove this.

OpenWebURL()

bool BlamKeystoneAPI::OpenWebURL

(

std::string

url

)

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

Parameters

url	- The URL to open.

Deprecated:

I don't think we need this. Verify if we do or don't, and if not then remove this.

ShowErrorDialog()

int BlamKeystoneAPI::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.

ShowFoundryWindow()

int BlamKeystoneAPI::ShowFoundryWindow

(

)

Shows the main Foundry window.

Returns

The Qt application execution result.

Todo:

Have return value changed over to use KeystoneDialogResult instead.

ShowGuerillaWindow()

int BlamKeystoneAPI::ShowGuerillaWindow

(

BlamConfigurationFile *

guerilla_config

)

Shows the main Guerilla window.

Returns

The Qt application execution result.

Todo:

Have return value changed over to use KeystoneDialogResult instead.

Remove parameter for guerilla config, as all accessing of config should be done directly.

ShowMainWindow()

int BlamKeystoneAPI::ShowMainWindow

(

)

Shows a default testing window.

Returns

Return code from the window.

Deprecated:

Should not be used. Will be removed.

ShowSapienWindow()

int BlamKeystoneAPI::ShowSapienWindow

(

)

Shows the main Sapien window.

Returns

The Qt application execution result.

Todo:

Have return value changed over to use KeystoneDialogResult instead.

ShowToolWindow()

int BlamKeystoneAPI::ShowToolWindow

(

)

Shows the Tool GUI window.

Returns

The Qt application execution result.