BlamEditorToolWindow Class Reference

Base class for all editor tool windows. More...

#include <BlamEditorToolWindow.h>

Inheritance diagram for BlamEditorToolWindow:

Collaboration diagram for BlamEditorToolWindow:

Public Member Functions
	BlamEditorToolWindow (BlamEditorToolWindowType _window_type)
	Constructs a new tool window. More...
	~BlamEditorToolWindow ()
	Releases a tool window. More...
BlamEditorToolWindowType	GetToolWindowType ()
	Retrieves the type of tool window that this tool window represents. More...
void	LoadConfig ()
	Loads or creates the configuration file for this tool window. More...
virtual void	OnThemeChange (BlamEditorTheme *new_theme)
	Called when the active theme is changed. More...
virtual void	OnToolOpen ()
	Called when the tool window is being opened. More...
virtual void	OnToolClose ()
	Called when the tool window is being closed. More...
void	closeEvent (QCloseEvent *event)
	Overrides the close event. More...
void	OnDockAreaChanged (Qt::DockWidgetArea area)
	Called when the dock area of the tool window is changed. More...
Qt::DockWidgetArea	GetDockWidgetArea ()

Public Attributes
std::string	config_filename = ""
	The name of the configuration filename. More...
BlamConfigurationFile *	config = nullptr
	The configuration file for this tool window. Not always used. More...

Protected Attributes
BlamEditorToolWindowType	window_type = BlamEditorToolWindowType::Unspecified
	The tool window type. More...
Qt::DockWidgetArea	dock_position = Qt::DockWidgetArea::LeftDockWidgetArea

Detailed Description

Base class for all editor tool windows.

Tool windows refer to any dockable window within the editing kit. The functionality of these can vary widely, and serve as the primary way to interact with the editing kit.

Constructor & Destructor Documentation

BlamEditorToolWindow()

BlamEditorToolWindow::BlamEditorToolWindow

(

BlamEditorToolWindowType

_window_type

)

Constructs a new tool window.

Parameters

_window_type

- The type of the new tool window.

Here is the call graph for this function:

~BlamEditorToolWindow()

BlamEditorToolWindow::~BlamEditorToolWindow

(

)

Releases a tool window.

This will ensure that the parent window no longer lists this window as an open tool window.

Here is the call graph for this function:

Member Function Documentation

closeEvent()

void BlamEditorToolWindow::closeEvent

(

QCloseEvent *

event

)

Overrides the close event.

This will stop any default window close functionality and will instead instruct the parent window to close the tool window itself - preventing a scenario where the tool window is closed and unable to be reopened later.

Here is the call graph for this function:

GetDockWidgetArea()

Qt::DockWidgetArea BlamEditorToolWindow::GetDockWidgetArea

(

)

Here is the caller graph for this function:

GetToolWindowType()

BlamEditorToolWindowType BlamEditorToolWindow::GetToolWindowType

(

)

Retrieves the type of tool window that this tool window represents.

Returns

The tool window type for this window.

Here is the caller graph for this function:

LoadConfig()

void BlamEditorToolWindow::LoadConfig

(

)

Loads or creates the configuration file for this tool window.

Here is the call graph for this function:

Here is the caller graph for this function:

OnDockAreaChanged()

void BlamEditorToolWindow::OnDockAreaChanged

(

Qt::DockWidgetArea

area

)

Called when the dock area of the tool window is changed.

Parameters

area	- The new dock area of the tool window.

Here is the caller graph for this function:

OnThemeChange()

virtual void BlamEditorToolWindow::OnThemeChange ( BlamEditorTheme *  new_theme )

inlinevirtual

Called when the active theme is changed.

Parameters

new_theme

- The newly applied theme.

OnToolClose()

virtual void BlamEditorToolWindow::OnToolClose ( )

inlinevirtual

Called when the tool window is being closed.

Here is the caller graph for this function:

OnToolOpen()

virtual void BlamEditorToolWindow::OnToolOpen ( )

inlinevirtual

Called when the tool window is being opened.

Reimplemented in BlamEditorToolWindow_ExplorerBar.

Here is the caller graph for this function:

Member Data Documentation

config

BlamConfigurationFile* BlamEditorToolWindow::config = nullptr

The configuration file for this tool window. Not always used.

config_filename

std::string BlamEditorToolWindow::config_filename = ""

The name of the configuration filename.

dock_position

Qt::DockWidgetArea BlamEditorToolWindow::dock_position = Qt::DockWidgetArea::LeftDockWidgetArea

protected

window_type

BlamEditorToolWindowType BlamEditorToolWindow::window_type = BlamEditorToolWindowType::Unspecified

protected

The tool window type.

See BlamEditorToolWindowType for details.

---

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

• keystone/components/editor_data/tool_window/BlamEditorToolWindow.h
• keystone/components/editor_data/tool_window/BlamEditorToolWindow.cpp