Editors::EditorUI class

Base classes

class _EditorUI_interface
class UTFWin::IWinProc
This class is a window procedure, also known as an event/message listener.
class App::IMessageListener
An interface that can receive messages sent through the app.
class DefaultRefCounted
The default implementation of a reference counted class.

Constructors, destructors, conversion operators

EditorUI()
~EditorUI() virtual

Public functions

auto Load(cEditor* pEditor, uint32_t instanceID, uint32_t groupID, bool editorModelForceSaveover) -> bool
auto HandleMessage(uint32_t messageID, void* msg) -> bool override
Called every time a message is received.
auto HandleUIMessage(UTFWin::IWindow* pWindow, const UTFWin::Message& message) -> bool override
Method called every time a message is received on a window that has this IWinProc added.
auto SetActiveMode(Mode mode) -> void

Public variables

UTFWin::UILayout mMainUI
UTFWin::UILayout mSharedUI
UTFWin::UILayout mCameraControlsUI
cEditor* mpEditor
int field_60
UTFWin::IWindow* field_64
UTFWin::IWindow* field_68
UTFWin::IWindow* field_6C
UTFWin::IWindow* field_70
int field_74
UTFWin::IWindow* field_78
int field_7C
UTFWin::IWindow* field_80
UTFWin::IWindow* field_84
int field_88
int field_8C
int field_90
int field_94
int field_98
int field_9C
bool mbEditorModelForceSaveover
bool field_A1
bool field_A2
char field_A3
int field_A4
int field_A8
int field_AC
int field_B0
int field_B4
int field_B8
int field_BC
int field_C0
int field_C4
int field_C8
int field_CC
bool field_D0
bool field_D1
int field_D4
int field_D8
int field_DC
int field_E0
bool field_E4
bool field_E5
int field_E8
bool field_EC
int field_F0
bool field_F4
int field_F8
int field_FC
bool field_100
bool field_101
bool field_102
bool field_103
bool field_104
bool field_105
bool field_106
bool field_107
int field_108
bool field_10C
int field_110
bool mbMessageListenerAdded
App::IMessageManager* mpMessageManager
App::IMessageListener* mpMessageListener
uint32_t* mMessageIDs
size_t mNumMessageIDs
int field_128

Function documentation

bool Editors::EditorUI::HandleMessage(uint32_t messageID, void* msg) override

Called every time a message is received.

Parameters
messageID The ID of the message received.
msg The data of the message received, it might be nullptr.
Returns Whether the message was handled or not.

Only the messages with an ID this listener signed up for will call this event.

bool Editors::EditorUI::HandleUIMessage(UTFWin::IWindow* pWindow, const UTFWin::Message& message) override

Method called every time a message is received on a window that has this IWinProc added.

Parameters
pWindow The window that received this message.
message The message received.
Returns Whether the message was handled or not.

This method is responsible of handling (or not) the message. This method receives the IWindow that is currently receiving the message; this way, the same IWinProc can be listening for more than one window. This method returns whether the message was handled or not; if it was handled, no other IWinProcs will be called on that window.