guerilla_window Class Reference

The main Guerilla window. More...

#include <guerilla_window.h>

Inheritance diagram for guerilla_window:

Public Member Functions
	guerilla_window (BlamConfigurationFile *guerilla_config, QWidget *parent=Q_NULLPTR)
	Initializes the application window. More...
	~guerilla_window ()
BlamResult	OpenTag (QString file_path)
	Attempts to open a tag for editing. More...
void	OpenNewTag (BlamTag *new_tag)
	Opens a tag for editing. More...
void	ToggleExplorer ()
	Toggles the Explorer Bar. More...
void	ToggleOutput ()
	Toggles the console output window. More...
void	OnThemeChange (BlamEditorTheme *new_theme)
	Updates the window icon when the active theme changes. More...
tag_editor *	GetCurrentTagEditor ()

Public Attributes
BlamConfigurationFile *	config
	Pointer to the Guerilla configuration file. More...
bool	show_explorer = false
	Whether or not the Explorer Bar is currently being displayed. More...
bool	show_output_window = false
	Whether or not the output window is currently being displayed. More...
SkinnableMdiArea *	mdi_area = nullptr
	The MDI area used for tag documents. Only set when using MDI layout. More...
QTabWidget *	tab_area = nullptr
	The tab widget used for tag documents. Only set when using Tab layout. More...
GuerillaLayoutType	layout_type
	The layout type the window is currently using. More...

Detailed Description

The main Guerilla window.

Constructor & Destructor Documentation

guerilla_window()

guerilla_window::guerilla_window	(	BlamConfigurationFile *	guerilla_config,
		QWidget *	parent = Q_NULLPTR
	)

Initializes the application window.

Parameters

guerilla_config

- Pointer to the Guerilla configuration file.

~guerilla_window()

guerilla_window::~guerilla_window

(

)

Member Function Documentation

GetCurrentTagEditor()

tag_editor * guerilla_window::GetCurrentTagEditor

(

)

OnThemeChange()

void guerilla_window::OnThemeChange ( BlamEditorTheme *  new_theme )

virtual

Updates the window icon when the active theme changes.

Parameters

new_theme

- The newly applied theme.

Reimplemented from KeystoneThemeChangeReceiver.

OpenNewTag()

void guerilla_window::OpenNewTag

(

BlamTag *

new_tag

)

Opens a tag for editing.

Parameters

new_tag

- The new tag to open.

OpenTag()

BlamResult guerilla_window::OpenTag

(

QString

file_path

)

Attempts to open a tag for editing.

Parameters

file_path

- The path to the tag file.

Returns

#BlamResult::Success_OK if the tag was opened successfully, otherwise returns an error code.

ToggleExplorer()

void guerilla_window::ToggleExplorer

(

)

Toggles the Explorer Bar.

ToggleOutput()

void guerilla_window::ToggleOutput

(

)

Toggles the console output window.

Member Data Documentation

config

BlamConfigurationFile* guerilla_window::config

Pointer to the Guerilla configuration file.

layout_type

GuerillaLayoutType guerilla_window::layout_type

The layout type the window is currently using.

mdi_area

SkinnableMdiArea* guerilla_window::mdi_area = nullptr

The MDI area used for tag documents. Only set when using MDI layout.

show_explorer

bool guerilla_window::show_explorer = false

Whether or not the Explorer Bar is currently being displayed.

show_output_window

bool guerilla_window::show_output_window = false

Whether or not the output window is currently being displayed.

tab_area

QTabWidget* guerilla_window::tab_area = nullptr

The tab widget used for tag documents. Only set when using Tab layout.

---

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

• keystone/components/ui/guerilla/main_window/guerilla_window.h
• keystone/components/ui/guerilla/main_window/guerilla_window.cpp