BlamUIWidget_Console Class Reference

#include <console.h>

Inheritance diagram for BlamUIWidget_Console:

Public Member Functions
	BlamUIWidget_Console (BlamUIWidget_Group *_parent)
	~BlamUIWidget_Console ()
void	Draw () override
void	ShowImGuiPropertyEditor () override
void	UpdateMetrics () override
void	RefreshRelativePosition () override
void	OnKeyPressEvent (KeyPressEvent *event) override
	Called when the listener is subscribed to Key Press events, and a new KeyPressEvent is fired. More...
void	OnCharacterInputEvent (CharacterInputEvent *event) override
	Called when the listener is subscribed to Character Input events, and a new CharacterInputEvent is fired. More...
void	OnTickEvent (TickEvent *event) override
	Called when the listener is subscribed to Key Press events, and a new TickEvent is fired. More...
void	OnLogMessageEvent (LogMessageEvent *event) override
	Called when the listener is subscribed to Log Message events, and a new LogMessageEvent is fired. More...
Public Member Functions inherited from BlamUIWidget
	BlamUIWidget (BlamWidgetType type)
	BlamUIWidget (BlamWidgetType type, BlamUIWidget_Group *_parent)
virtual	~BlamUIWidget ()
BlamWidgetType	GetType ()
void	RefreshRelativePosition (int viewport_width, int viewport_height, BlamVector2 initial_position)
void	SetSize (BlamVector2 new_size)
void	SetPosition (BlamVector2 new_position)
void	SetRotation (float new_rotation)
void	SetAnchorPosition (BlamWidgetAnchor new_anchor_position)
BlamVector2	GetAbsolutePosition ()
Public Member Functions inherited from BlamEventListener
void	Subscribe (BlamEventType type)
	Subscribes to an event type. More...
	~BlamEventListener ()
std::vector< BlamEventType >	GetSubscribedEvents ()
	Retrieves the list of subscribed event types. More...
bool	IsSubscribed (BlamEventType type)
	Determines whether or not the listener is subscribed to the specified event type. More...
void	SetPriority (int new_priority)
	Sets the priority of the listener. More...
int	GetPriority ()
	Retrieves the priority of the listener. More...
virtual void	OnConfigurationReloadEvent (ConfigurationReloadEvent *event)
	Called when the listener is subscribed to configuration reload events, and a new ConfigurationReloadEvent is fired. More...
virtual void	OnMouseClickEvent (MouseClickEvent *event)
	Called when the listener is subscribed to Mouse Click events, and a new MouseClickEvent is fired. More...
virtual void	OnMouseMoveEvent (MouseMoveEvent *event)
	Called when the listener is subscribed to Mouse Move events, and a new MouseMoveEvent is fired. More...
virtual void	OnNewFrameEvent (NewFrameEvent *event)
	Called when the listener is subscribed to New Frame events, and a new NewFrameEvent is fired. More...

Additional Inherited Members
Public Attributes inherited from BlamUIWidget
std::string	display_name = "unnamed"
std::string	description = ""
BlamVector2	position = { 0, 0 }
BlamVector2	size = { 100, 100 }
float	rotation = 0.0f
bool	hidden = false
BlamUIWidget_Group *	parent = nullptr
Public Attributes inherited from BlamEventListener
std::string	name = ""
	The name of the listener. Used for debugging purposes. More...
Protected Attributes inherited from BlamUIWidget
BlamVector2	position_absolute = { 0, 0 }
BlamVector2	size_absolute = { 100, 100 }

Constructor & Destructor Documentation

BlamUIWidget_Console()

BlamUIWidget_Console::BlamUIWidget_Console

(

BlamUIWidget_Group *

_parent

)

~BlamUIWidget_Console()

BlamUIWidget_Console::~BlamUIWidget_Console

(

)

Member Function Documentation

Draw()

void BlamUIWidget_Console::Draw ( )

overridevirtual

Reimplemented from BlamUIWidget.

OnCharacterInputEvent()

void BlamUIWidget_Console::OnCharacterInputEvent ( CharacterInputEvent *  event )

overridevirtual

Called when the listener is subscribed to Character Input events, and a new CharacterInputEvent is fired.

Parameters

event

- The event that was fired.

Reimplemented from BlamEventListener.

OnKeyPressEvent()

void BlamUIWidget_Console::OnKeyPressEvent ( KeyPressEvent *  event )

overridevirtual

Called when the listener is subscribed to Key Press events, and a new KeyPressEvent is fired.

Parameters

event

- The event that was fired.

Reimplemented from BlamEventListener.

OnLogMessageEvent()

void BlamUIWidget_Console::OnLogMessageEvent ( LogMessageEvent *  event )

overridevirtual

Called when the listener is subscribed to Log Message events, and a new LogMessageEvent is fired.

Parameters

event

- The event that was fired.

Reimplemented from BlamEventListener.

OnTickEvent()

void BlamUIWidget_Console::OnTickEvent ( TickEvent *  event )

overridevirtual

Called when the listener is subscribed to Key Press events, and a new TickEvent is fired.

Parameters

event

- The event that was fired.

Reimplemented from BlamEventListener.

RefreshRelativePosition()

void BlamUIWidget_Console::RefreshRelativePosition ( )

overridevirtual

Reimplemented from BlamUIWidget.

ShowImGuiPropertyEditor()

void BlamUIWidget_Console::ShowImGuiPropertyEditor ( )

overridevirtual

Reimplemented from BlamUIWidget.

UpdateMetrics()

void BlamUIWidget_Console::UpdateMetrics ( )

overridevirtual

Reimplemented from BlamUIWidget.

---

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

• blam/components/ui/blam/widgets/advanced/console.h
• blam/components/ui/blam/widgets/advanced/BlamUIWidget_Console.cpp