Elaztek Developer Hub
Blamite Game Engine - Keystone  00326.06.27.21.0407.blamite
A library that enables the use of Qt in Blamite's editing tools.
BlamEditorToolWindow Class Reference

#include <BlamEditorToolWindow.h>

+ Inheritance diagram for BlamEditorToolWindow:

Public Member Functions

 BlamEditorToolWindow (BlamEditorWindow *_window, 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...
 

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...
 
Qt::DockWidgetArea dock_position = Qt::DockWidgetArea::LeftDockWidgetArea
 

Protected Attributes

BlamEditorWindowparent_window = nullptr
 The parent window that owns this tool window. More...
 
BlamEditorToolWindowType window_type = BlamEditorToolWindowType::Unspecified
 The tool window type. More...
 

Constructor & Destructor Documentation

◆ BlamEditorToolWindow()

BlamEditorToolWindow::BlamEditorToolWindow ( BlamEditorWindow _window,
BlamEditorToolWindowType  _window_type 
)

Constructs a new tool window.

Parameters
_window- Pointer to the parent editor window that owns this tool window.
_window_type- The type of the new tool window.

◆ ~BlamEditorToolWindow()

BlamEditorToolWindow::~BlamEditorToolWindow ( )

Releases a tool window.

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

Member Function Documentation

◆ GetToolWindowType()

BlamEditorToolWindowType BlamEditorToolWindow::GetToolWindowType ( )

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

Returns
The tool window type for this window.

◆ LoadConfig()

void BlamEditorToolWindow::LoadConfig ( )

Loads or creates the configuration file for this tool window.

◆ OnThemeChange()

virtual void BlamEditorToolWindow::OnThemeChange ( BlamEditorTheme new_theme)
inlinevirtual

Called when the active theme is changed.

Parameters
new_theme- The newly applied theme.

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

◆ parent_window

BlamEditorWindow* BlamEditorToolWindow::parent_window = nullptr
protected

The parent window that owns this tool window.

◆ 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: