Elaztek Developer Hub
Blamite Game Engine - Keystone  00390.07.02.23.1947.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.
editor_data.h
themes
std::vector< BlamEditorTheme > themes
The current list of loaded themes.
Definition: themes.cpp:14
MIT
Font Awesome Free License Font Awesome Free is open and GPL friendly You can use it for commercial open source or really almost whatever you want Full Font Awesome Free the CC BY license applies to all icons packaged as SVG and JS file types In the Font Awesome Free the SIL OFL license applies to all icons packaged as web and desktop font files In the Font Awesome Free the MIT license applies to all non font and non icon files Attribution is required by MIT
Definition: LICENSE.txt:21
KeystoneDialogResult
KeystoneDialogResult
Enumerator containing all possible generic dialog results.
Definition: keystone_api.h:30
BlamKeystone::GetQApplication
KEYSTONE QApplication * GetQApplication()
Retrieves the pointer to the current Qt application.
Definition: keystone_main.cpp:93
QSourceHighlite::QSourceHighliterTheme::theme
QHash< QSourceHighliter::Token, QTextCharFormat > theme(QSourceHighliter::Themes)
Definition: qsourcehighliterthemes.cpp:63
free
Font Awesome Free License Font Awesome Free is free
Definition: LICENSE.txt:4
guerilla_window.h
can
This folder contains built in editor themes You probably shouldn t touch these You can
Definition: readme.txt:3
error_dialog.h
license
Font Awesome Free License Font Awesome Free is open and GPL friendly You can use it for commercial open source or really almost whatever you want Full Font Awesome Free license
Definition: LICENSE.txt:9
keystone_main.h
BlamKeystoneAPI
Namespace containing any exported functions within Keystone.
Definition: keystone_api.h:50
KeystoneDialogResult::Cancel
@ Cancel
The user pressed the 'Cancel' button.
source
Font Awesome Free License Font Awesome Free is open source
Definition: LICENSE.txt:4
KeystoneDialogResult::Exit
@ Exit
Indicates the user choosed the "Exit" option.
path
This folder contains built in editor themes You probably shouldn t touch these You we won t stop you but if you are looking to customize how your editor we encourage you to instead add a new user theme instead User themes are found in the following path
Definition: readme.txt:5
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
looks
This folder contains built in editor themes You probably shouldn t touch these You we won t stop you but if you are looking to customize how your editor looks
Definition: readme.txt:4
root
This folder contains built in editor themes You probably shouldn t touch these You we won t stop you but if you are looking to customize how your editor we encourage you to instead add a new user theme instead User themes are found in the following relative to the engine root
Definition: readme.txt:11
tool_gui_window
The main window for Tool's GUI.
Definition: tool_gui_window.h:17
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
keystone_api.h
sapien_main_window
The main window for Sapien.
Definition: sapien_main_window.h:16
KeystoneDialogResult::SafeMode
@ SafeMode
Indicates the user choosed the "Continue in Safe Mode" option.
BlamKeystone::EditorData::Internal::SetMainEditorWindow
KEYSTONE void SetMainEditorWindow(BlamEditorWindow *window)
Sets the main editor window.
Definition: editor_data.cpp:27
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
UI
This is where any user installed Editor themes can be placed Any editing tools that use Qt for their UI(and utilize custom themes) will detect any theme folders you place here. To learn more about creating custom editor themes
attribution
Font Awesome Free License Font Awesome Free is open and GPL friendly You can use it for commercial open source or really almost whatever you want Full Font Awesome Free the CC BY license applies to all icons packaged as SVG and JS file types In the Font Awesome Free the SIL OFL license applies to all icons packaged as web and desktop font files In the Font Awesome Free the MIT license applies to all non font and non icon files Attribution is required by SIL and CC BY licenses Downloaded Font Awesome Free files already contain embedded comments with sufficient attribution
Definition: LICENSE.txt:23
foundry_main_window
The main window for Foundry.
Definition: foundry_main_window.h:13
OFL
Font Awesome Free License Font Awesome Free is open and GPL friendly You can use it for commercial open source or really almost whatever you want Full Font Awesome Free the CC BY license applies to all icons packaged as SVG and JS file types In the Font Awesome Free the SIL OFL license applies to all icons packaged as web and desktop font files In the Font Awesome Free the MIT license applies to all non font and non icon files Attribution is required by SIL OFL
Definition: LICENSE.txt:21
User
@ User
Indicates the theme is a custom theme added by the user.
Definition: themes.h:25
BlamKeystoneAPI::ShowSapienWindow
KEYSTONE_API int ShowSapienWindow()
Shows the main Sapien window.
Definition: keystone_api.cpp:23
download
Font Awesome Free License Font Awesome Free is open and GPL friendly You can use it for commercial open source or really almost whatever you want Full Font Awesome Free the CC BY license applies to all icons packaged as SVG and JS file types In the Font Awesome Free download
Definition: LICENSE.txt:13
kit
This folder contains built in editor themes You probably shouldn t touch these You we won t stop you but if you are looking to customize how your editor we encourage you to instead add a new user theme instead User themes are found in the following relative to the engine and has theme support For more information on theming the editing kit
Definition: readme.txt:12
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.
ErrorDialog
GUI for the Qt-based error dialog box.
Definition: error_dialog.h:12
foundry_main_window.h
KeystoneDialogResult::No
@ No
The user pressed the 'No' button.
sapien_main_window.h
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.
guerilla_window
The main Guerilla window.
Definition: guerilla_window.h:18
KeystoneDialogResult::Continue
@ Continue
Indicates the user choosed the "Continue" option.
projects
Font Awesome Free License Font Awesome Free is open and GPL friendly You can use it for commercial projects
Definition: LICENSE.txt:5
tool_gui_window.h
ErrorDialog::GetResult
KeystoneDialogResult GetResult()
Retrieves the result of the dialog.
Definition: error_dialog.cpp:21