tool_gui_window Class Reference

The main window for Tool's GUI. More...

#include <tool_gui_window.h>

Inheritance diagram for tool_gui_window:

Public Member Functions
	tool_gui_window (QWidget *parent=Q_NULLPTR)
	~tool_gui_window ()
Public Member Functions inherited from BlamEditorWindow
	BlamEditorWindow (BlamEditorWindowType window_type)
	Constructs a new editor window. More...
void	SetupWindow ()
	Prepares the main window layout. More...
BlamEditorWindowType	GetEditorWindowType ()
	Retrieves the type of the editor window. More...
virtual void	OnThemeChange (BlamEditorTheme *new_theme)
	Called when the active theme is changed. More...
bool	OpenDocument (std::string file_path, BlamTagTreeNode *tree_node, BlamEditorDocumentType doctype)
	Attempts to open the specified document in the main window. More...
void	OpenDocument (BlamEditorDocument *document)
	Opens a pre-prepared document and associates it with this window. More...
void	CloseDocument (int index)
	Attempts to close the specified document. More...
void	CloseDocument (BlamEditorDocument *document)
	Attempts to close the specified document. More...
void	SaveAllDocuments ()
	Attempts to save all open documents. More...
bool	OpenToolWindow (BlamEditorToolWindowType tool_type, Qt::DockWidgetArea position)
	Opens the specified tool window within the main window. More...
bool	OpenToolWindow (BlamEditorToolWindowType tool_type)
	Opens the specified tool window within the main window. More...
void	CloseToolWindow (BlamEditorToolWindowType tool_type)
	Closes the specified tool window. More...
void	ToggleToolWindow (BlamEditorToolWindowType tool_type)
	Toggles the specified tool window. More...
bool	IsToolWindowOpen (BlamEditorToolWindowType tool_type)
	Checks if a given tool window type is open. More...
BlamEditorDocument *	GetActiveDocument ()
	Get the current active document. More...

Additional Inherited Members
Public Attributes inherited from BlamEditorWindow
BlamWorkspaceLayoutType	workspace_type = BlamWorkspaceLayoutType::MDI
	The layout type the window is currently using. More...
SkinnableMdiArea *	mdi_area = nullptr
	The MDI area used for documents. Only set when using MDI layout. More...
QTabWidget *	tab_area = nullptr
	The tab widget used for documents. Only set when using Tab layout. More...
std::vector< BlamEditorToolWindow * >	open_tool_windows = std::vector<BlamEditorToolWindow*>()
	The list of open tool windows. More...
std::vector< BlamEditorDocument * >	open_documents = std::vector<BlamEditorDocument*>()
	The list of open documents. More...

Detailed Description

The main window for Tool's GUI.

When we start implementing Tool, in order to aid in ease of use, it will feature a GUI frontend. The application can still be run without the GUI, but the GUI will make it easier for those new to the engine to get started.

Todo:

Implement.

Constructor & Destructor Documentation

tool_gui_window()

tool_gui_window::tool_gui_window

(

QWidget *

parent = Q_NULLPTR

)

~tool_gui_window()

tool_gui_window::~tool_gui_window

(

)

---

The documentation for this class was generated from the following files:

• keystone/components/ui/tool/main_window/tool_gui_window.h
• keystone/components/ui/tool/main_window/tool_gui_window.cpp