Elaztek Developer Hub
Blamite Game Engine - Keystone  00402.09.29.23.0627.blamite
A library that enables the use of Qt in Blamite's editing tools.
BlamEditorDocument.h
Go to the documentation of this file.
1 #pragma once
2 
3 #include <qwidget.h>
4 #include <qmdisubwindow.h>
5 #include <string>
6 #include <Strings/components/settings/config/config.h>
7 
9 
10 #ifndef KEYSTONE
11 #define KEYSTONE
12 #endif
13 
14 class BlamEditorWindow;
16 
24 {
25  Tag,
26  GameWindow,
27  TagDesigner,
29 };
30 
38 {
39 private:
44 
45 public:
46 
48 
49  std::string document_title = "document";
51  bool loaded = true;
52  bool modified = false;
53 
54  bool override_icon = false;
55  std::string custom_icon_group = "";
56  std::string custom_icon_id = "";
57 
58  std::string file_path = "";
59  std::string document_context = "";
60 
61  int mdi_default_width = 700;
62  int mdi_default_height = 700;
63 
71 
78 
84  virtual void OnThemeChange(BlamEditorTheme* new_theme) {};
85 
89  void Show();
90 
94  void UpdateDefaultIcon();
95 
106  virtual bool ConfirmClose(std::string confirmation_message = "");
107 
114  virtual void FlagAsModified(bool new_modified_state = true);
115 
121  virtual bool Close();
122 
130  virtual bool Close(bool force_close);
131 
135  virtual void Save() {};
136 
140  virtual void SaveAs() {};
141 
145  virtual void OnFocused() {};
146 
150  virtual void OnUnfocused() {};
151 };
152 
153 class BlamEditorDocumentSubWindow : public QMdiSubWindow
154 {
155 public:
157 
158  BlamEditorDocumentSubWindow(QWidget* parent = nullptr) : QMdiSubWindow(parent) {}
159 
160  void closeEvent(QCloseEvent* closeEvent);
161 };
162 
168 class BlamEditorDocumentWidget : public QWidget
169 {
170 public:
172 
173  BlamEditorDocumentWidget(QWidget* parent = nullptr) : QWidget(parent) {}
174 };
175 
177 {
182 
187 
195  KEYSTONE BlamConfigurationFile* GetDocumentTypeConfiguration(BlamEditorDocumentType type);
196 
202  KEYSTONE std::map<BlamEditorDocumentType, BlamConfigurationFile*> GetDocumentTypeConfigurations();
203 }
BlamEditorDocument::custom_icon_id
std::string custom_icon_id
The resource ID of the custom icon. Only used when override_icon is true.
Definition: BlamEditorDocument.h:56
BlamEditorDocument::mdi_default_height
int mdi_default_height
The default starting height of the document's MDI window.
Definition: BlamEditorDocument.h:62
BlamEditorDocument::mdi_default_width
int mdi_default_width
The default starting width of the document's MDI window.
Definition: BlamEditorDocument.h:61
BlamEditorDocument::GetDocumentType
BlamEditorDocumentType GetDocumentType()
Retrieves the type of this document.
Definition: BlamEditorDocument.cpp:17
editor_data.h
BlamEditorDocument::parent_window
BlamEditorWindow * parent_window
The parent window that owns this document.
Definition: BlamEditorDocument.h:47
BlamEditorDocument::file_path
std::string file_path
The path to the file associated with this document.
Definition: BlamEditorDocument.h:58
BlamEditorDocumentType::GameWindow
@ GameWindow
Special document type used for the Game Viewport window.
BlamEditorWindowType::Tool
@ Tool
The editor window is the GUI for Tool (see tool_gui_window).
BlamWorkspaceLayoutType::Tabs
@ Tabs
Sub-windows will be organized using tabs, similar to more modern editing tools.
KeystoneDialogResult
KeystoneDialogResult
Enumerator containing all possible generic dialog results.
Definition: keystone_api.h:30
BlamEditorWindow::workspace_type
BlamWorkspaceLayoutType workspace_type
The layout type the window is currently using.
Definition: BlamEditorWindow.h:59
BlamEditorWindow::GetEditorWindowType
BlamEditorWindowType GetEditorWindowType()
Retrieves the type of the editor window.
Definition: BlamEditorWindow.cpp:89
BlamEditorWindowType::Sapien
@ Sapien
The editor window is the main window for Sapien (see sapien_main_window).
BlamEditorDocumentWidget::document
BlamEditorDocument * document
The document associated with this widget.
Definition: BlamEditorDocument.h:171
BlamEditorWindow::GetApplicationTitle
std::string GetApplicationTitle()
Definition: BlamEditorWindow.cpp:406
BlamEditorWindow::open_documents
std::vector< BlamEditorDocument * > open_documents
The list of open documents.
Definition: BlamEditorWindow.h:65
BlamEditorDocumentType
BlamEditorDocumentType
Enumerator containing all possible editor document types.
Definition: BlamEditorDocument.h:23
BlamEditorDocument::document_title
std::string document_title
The title of this document.
Definition: BlamEditorDocument.h:49
themes.h
BlamKeystone::EditorData::UnloadDocumentConfigurations
KEYSTONE void UnloadDocumentConfigurations()
Unloads all document type configurations.
Definition: document_config.cpp:91
BlamEditorTheme
Class representing a Blamite Editor Theme.
Definition: themes.h:47
BlamEditorDocument.h
BlamEditorDocument::FlagAsModified
virtual void FlagAsModified(bool new_modified_state=true)
Flags the document as being modified.
Definition: BlamEditorDocument.cpp:75
BlamEditorDocument::BlamEditorDocument
BlamEditorDocument(BlamEditorWindow *_window, BlamEditorDocumentType doctype)
Constructs a new BlamEditorDocument.
Definition: BlamEditorDocument.cpp:11
BlamKeystone::Utils::ShowMessageBox
KEYSTONE KeystoneDialogResult ShowMessageBox(std::string message)
Definition: utils.cpp:279
BlamEditorDocument::UpdateDefaultIcon
void UpdateDefaultIcon()
Updates the document's icon.
Definition: BlamEditorDocument.cpp:195
BlamEditorWindowType::Guerilla
@ Guerilla
The editor window is the main window for Guerilla (see guerilla_window).
BlamEditorDocumentWidget::BlamEditorDocumentWidget
BlamEditorDocumentWidget(QWidget *parent=nullptr)
Definition: BlamEditorDocument.h:173
BlamEditorDocument::modified
bool modified
Whether or not the document has been modified.
Definition: BlamEditorDocument.h:52
BlamWorkspaceLayoutType
BlamWorkspaceLayoutType
Enumerator used to specify the workspace layout method that an application should use.
Definition: BlamEditorWindow.h:21
utils.h
BlamEditorDocumentType::TagDesigner
@ TagDesigner
Special document type used for the Tag Designer window.
BlamEditorWindow.h
BlamEditorDocumentType::Tag
@ Tag
Indicates the document represents a tag file.
KeystoneMessageBoxButtons::YesNoCancel
@ YesNoCancel
Dialog is shown with a [Yes], [No], and [Cancel] button.
BlamEditorDocumentSubWindow::document
BlamEditorDocument * document
The document associated with this widget.
Definition: BlamEditorDocument.h:156
BlamKeystone::Themes::GetActiveTheme
KEYSTONE BlamEditorTheme * GetActiveTheme()
Retrieves the currently selected theme.
Definition: themes.cpp:335
BlamKeystone::EditorData::LoadDocumentConfigurations
KEYSTONE void LoadDocumentConfigurations()
Loads all document type configurations.
Definition: document_config.cpp:83
BlamEditorDocument::SaveAs
virtual void SaveAs()
Attempts to save the document, prompting the user to save as a new file.
Definition: BlamEditorDocument.h:140
KeystoneDialogResult::Yes
@ Yes
The user pressed the 'Yes' button.
BlamWorkspaceLayoutType::MDI
@ MDI
Sub-windows will be organized using MDI (Multiple Document Interface).
BlamEditorDocumentWidget
Class acting as a simple interface to allow for easy retrieval of the active document.
Definition: BlamEditorDocument.h:168
BlamEditorDocument::OnUnfocused
virtual void OnUnfocused()
Called when the document is unfocused.
Definition: BlamEditorDocument.h:150
BlamKeystone::EditorData::GetMainEditorWindow
KEYSTONE BlamEditorWindow * GetMainEditorWindow()
Retrieves the main editor window.
Definition: editor_data.cpp:32
BlamEditorDocumentSubWindow::BlamEditorDocumentSubWindow
BlamEditorDocumentSubWindow(QWidget *parent=nullptr)
Definition: BlamEditorDocument.h:158
BlamEditorDocument::document_context
std::string document_context
The context of this document. Will generally be a project or tag folder.
Definition: BlamEditorDocument.h:59
BlamEditorDocument::Save
virtual void Save()
Attempts to save the document, replacing the original file.
Definition: BlamEditorDocument.h:135
KeystoneMessageBoxType::Question
@ Question
Dialog icon will be a speech bubble with a question mark.
BlamEditorDocument
Interface class that any types of editor documents inherit from.
Definition: BlamEditorDocument.h:37
BlamEditorDocument::custom_icon_group
std::string custom_icon_group
The resource group containing the custom icon name. Only used when override_icon is true.
Definition: BlamEditorDocument.h:55
BlamEditorWindow::tab_area
QTabWidget * tab_area
The tab widget used for documents. Only set when using Tab layout.
Definition: BlamEditorWindow.h:62
BlamEditorWindow::mdi_area
SkinnableMdiArea * mdi_area
The MDI area used for documents. Only set when using MDI layout.
Definition: BlamEditorWindow.h:61
BlamKeystone::EditorData::GetDocumentTypeConfigurations
KEYSTONE std::map< BlamEditorDocumentType, BlamConfigurationFile * > GetDocumentTypeConfigurations()
Retrieves the list of loaded document type configuration files.
Definition: document_config.cpp:117
BlamEditorDocument::OnThemeChange
virtual void OnThemeChange(BlamEditorTheme *new_theme)
Called when the active theme is changed.
Definition: BlamEditorDocument.h:84
BlamEditorDocument::Show
void Show()
Shows the document within the parent window.
Definition: BlamEditorDocument.cpp:22
BlamEditorDocument::loaded
bool loaded
Whether or not the document was able to be successfully loaded.
Definition: BlamEditorDocument.h:51
BlamEditorWindow
Interface class that all main editing tool windows inherit from.
Definition: BlamEditorWindow.h:48
BlamEditorDocumentType::Unspecified
@ Unspecified
Indicates the document type is unspecified or invalid.
BlamEditorDocumentSubWindow::closeEvent
void closeEvent(QCloseEvent *closeEvent)
Definition: BlamEditorDocumentSubWindow.cpp:5
KEYSTONE
#define KEYSTONE
Definition: BlamEditorDocument.h:11
KeystoneDialogResult::No
@ No
The user pressed the 'No' button.
BlamEditorDocumentSubWindow
Definition: BlamEditorDocument.h:153
BlamEditorDocument::Close
virtual bool Close()
Closes the document and releases any resources being used by it.
Definition: BlamEditorDocument.cpp:158
BlamKeystone::EditorData
Namespace contianing functions for accessing common editor data.
Definition: BlamEditorDocument.h:176
BlamEditorWindowType::Foundry
@ Foundry
The editor window is the main window for Foundry (see foundry_main_window).
BlamEditorDocument::ConfirmClose
virtual bool ConfirmClose(std::string confirmation_message="")
Called immediately before closing a document.
Definition: BlamEditorDocument.cpp:269
BlamEditorDocument::override_icon
bool override_icon
Whether or not this document uses a custom icon other than the application default.
Definition: BlamEditorDocument.h:54
BlamEditorDocument::OnFocused
virtual void OnFocused()
Called when the document is focused.
Definition: BlamEditorDocument.h:145
BlamEditorDocument::ui
BlamEditorDocumentWidget * ui
The GUI widget associated with this document.
Definition: BlamEditorDocument.h:50
BlamKeystone::EditorData::GetDocumentTypeConfiguration
KEYSTONE BlamConfigurationFile * GetDocumentTypeConfiguration(BlamEditorDocumentType type)
Attempts to locate the configuration file for the specified document type.
Definition: document_config.cpp:107