Elaztek Developer Hub
Blamite Game Engine - Keystone  00381.04.17.23.2324.blamite
A library that enables the use of Qt in Blamite's editing tools.
keystone_api.h
Go to the documentation of this file.
1 // Blamite Game Engine - keystone.dll Exports Header //
3 // Copyright (c) 2013-2020 Elaztek Studios //
5 
6 #pragma once
7 
8 #include <string>
9 
10 #ifdef KEYSTONE_EXPORTS
11 
14 #define KEYSTONE_API extern "C" __declspec(dllexport)
15 #else
16 #define KEYSTONE_API extern "C" __declspec(dllimport)
17 #endif
18 
19 #ifndef KEYSTONE
20 #define KEYSTONE
21 #endif
22 
23 class BlamConfigurationFile;
24 enum BlamResult;
25 class BlamBasicLogger;
26 
31 {
32  OK,
33  Cancel,
34  Abort,
35  Retry,
36  Ignore,
37  Yes,
38  No,
39 
40  SafeMode,
41  Continue,
42  Exit,
43 
45 };
46 
50 namespace BlamKeystoneAPI
51 {
61  KEYSTONE_API KeystoneDialogResult ShowErrorDialog(bool allow_safemode, bool allow_continue, std::string text);
62 
69 
76 
83 
90 
98  KEYSTONE_API bool OpenWebURL(std::string url);
99 
107  KEYSTONE_API bool OpenLocalURL(std::string url);
108 
109 }
KeystoneDialogResult::Default_NotSet
@ Default_NotSet
The dialog result has not yet been set.
KeystoneDialogResult
KeystoneDialogResult
Enumerator containing all possible generic dialog results.
Definition: keystone_api.h:30
BlamKeystoneAPI
Namespace containing any exported functions within Keystone.
Definition: keystone_api.h:50
KeystoneDialogResult::Cancel
@ Cancel
The user pressed the 'Cancel' button.
KeystoneDialogResult::Exit
@ Exit
Indicates the user choosed the "Exit" option.
KeystoneDialogResult::OK
@ OK
The user pressed the 'OK' button.
BlamKeystoneAPI::OpenLocalURL
KEYSTONE_API bool OpenLocalURL(std::string url)
Opens a local file with the user's default application.
Definition: keystone_api.cpp:68
KeystoneDialogResult::Ignore
@ Ignore
The user pressed the 'Ignore' button.
BlamKeystoneAPI::ShowFoundryWindow
KEYSTONE_API int ShowFoundryWindow()
Shows the main Foundry window.
Definition: keystone_api.cpp:33
BlamKeystoneAPI::OpenWebURL
KEYSTONE_API bool OpenWebURL(std::string url)
Opens a URL in the user's default web browser.
Definition: keystone_api.cpp:63
KeystoneDialogResult::SafeMode
@ SafeMode
Indicates the user choosed the "Continue in Safe Mode" option.
BlamKeystoneAPI::ShowErrorDialog
KEYSTONE_API KeystoneDialogResult ShowErrorDialog(bool allow_safemode, bool allow_continue, std::string text)
Shows a Qt-driven error dialog.
Definition: keystone_api.cpp:13
KeystoneDialogResult::Yes
@ Yes
The user pressed the 'Yes' button.
KEYSTONE_API
#define KEYSTONE_API
Definition: keystone_api.h:16
BlamKeystoneAPI::ShowSapienWindow
KEYSTONE_API int ShowSapienWindow()
Shows the main Sapien window.
Definition: keystone_api.cpp:23
BlamKeystoneAPI::ShowToolWindow
KEYSTONE_API int ShowToolWindow()
Shows the Tool GUI window.
Definition: keystone_api.cpp:53
KeystoneDialogResult::Abort
@ Abort
The user pressed the 'Abort' button.
KeystoneDialogResult::No
@ No
The user pressed the 'No' button.
BlamKeystoneAPI::ShowGuerillaWindow
KEYSTONE_API int ShowGuerillaWindow()
Shows the main Guerilla window.
Definition: keystone_api.cpp:43
KeystoneDialogResult::Retry
@ Retry
The user pressed the 'Retry' button.
KeystoneDialogResult::Continue
@ Continue
Indicates the user choosed the "Continue" option.